io.deephaven.api.updateby.OperationControl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-table-api Show documentation
The Deephaven table operations API
The newest version!
//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.api.updateby;

import org.immutables.value.Value;
import org.immutables.value.Value.Immutable;
import io.deephaven.annotations.BuildableStyle;

import java.math.MathContext;
import java.util.Optional;

/**
 * 
 * Control parameters for performing operations with Table#updateBy()
 * 
 * 
 * Defaults are as follows
 * 
 * 
 * On null Values - Skip
 * On NaN Values - Skip
 * On null timestamps - Skip
 * On zero delta Time - Skip
 * On negative delta time - Throw Exception
 * BigDecimal / BigInteger MathContext - Decimal 128
 * 
 */
@Immutable
@BuildableStyle
public abstract class OperationControl {
    public static Builder builder() {
        return ImmutableOperationControl.builder();
    }

    public static OperationControl defaultInstance() {
        return builder().build();
    }

    public abstract Optional onNullValue();

    public abstract Optional onNanValue();

    public abstract Optional onNullTime();

    public abstract Optional onNegativeDeltaTime();

    public abstract Optional onZeroDeltaTime();

    public abstract Optional bigValueContext();

    /**
     * Get the behavior for when {@code null} values are encountered. Defaults to {@link BadDataBehavior#SKIP SKIP}.
     * 
     * @return the behavior for {@code null} values.
     */
    @Value.Derived
    public BadDataBehavior onNullValueOrDefault() {
        return onNullValue().orElse(BadDataBehavior.SKIP);
    }

    /**
     * Get the behavior for when {@link Double#NaN} values are encountered. Defaults to {@link BadDataBehavior#SKIP
     * SKIP}.
     * 
     * @return the behavior for {@link Double#NaN} values
     */
    @Value.Derived
    public BadDataBehavior onNanValueOrDefault() {
        return onNanValue().orElse(BadDataBehavior.SKIP);
    }

    /**
     * Get the {@link MathContext} to use when processing {@link java.math.BigInteger} and {@link java.math.BigDecimal}
     * values. Defaults to {@link MathContext#DECIMAL128}.
     * 
     * @return the {@link MathContext}
     */
    @Value.Derived
    public MathContext bigValueContextOrDefault() {
        return bigValueContext().orElse(MathContext.DECIMAL128);
    }

    /**
     * Create a new instance with all of the explicit-or-default values from {@code this}. This may be useful from the
     * context of a client who wants to use client-side configuration defaults instead of server-side configuration
     * defaults.
     *
     * @return the explicit new instance
     */
    public final OperationControl materialize() {
        return builder()
                .onNullValue(onNullValueOrDefault())
                .onNanValue(onNanValueOrDefault())
                .bigValueContext(bigValueContextOrDefault())
                .build();
    }

    public interface Builder {
        Builder onNullValue(BadDataBehavior badDataBehavior);

        Builder onNanValue(BadDataBehavior badDataBehavior);

        Builder bigValueContext(MathContext context);

        OperationControl build();
    }
}