Package io.deephaven.api.updateby

Class OperationControl

java.lang.Object

io.deephaven.api.updateby.OperationControl

@Immutable
public abstract class OperationControl
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OperationControl.Builder

Constructor Summary

Constructors

Constructor	Description
OperationControl()

Method Summary

Modifier and Type	Method	Description
abstract Optional<MathContext>	bigValueContext()
MathContext	bigValueContextOrDefault()	Get the MathContext to use when processing BigInteger and BigDecimal values.
static OperationControl.Builder	builder()
static OperationControl	defaultInstance()
final OperationControl	materialize()	Create a new instance with all of the explicit-or-default values from this.
abstract Optional<BadDataBehavior>	onNanValue()
BadDataBehavior	onNanValueOrDefault()	Get the behavior for when Double.NaN values are encountered.
abstract Optional<BadDataBehavior>	onNegativeDeltaTime()
abstract Optional<BadDataBehavior>	onNullTime()
abstract Optional<BadDataBehavior>	onNullValue()
BadDataBehavior	onNullValueOrDefault()	Get the behavior for when null values are encountered.
abstract Optional<BadDataBehavior>	onZeroDeltaTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OperationControl

public OperationControl()

Method Details

builder

public static OperationControl.Builder builder()

defaultInstance

public static OperationControl defaultInstance()

onNullValue

public abstract Optional<BadDataBehavior> onNullValue()

onNanValue

public abstract Optional<BadDataBehavior> onNanValue()

onNullTime

public abstract Optional<BadDataBehavior> onNullTime()

onNegativeDeltaTime

public abstract Optional<BadDataBehavior> onNegativeDeltaTime()

onZeroDeltaTime

public abstract Optional<BadDataBehavior> onZeroDeltaTime()

bigValueContext

public abstract Optional<MathContext> bigValueContext()

onNullValueOrDefault

@Derived
public BadDataBehavior onNullValueOrDefault()

Get the behavior for when null values are encountered. Defaults to SKIP.

Returns:

the behavior for null values.

onNanValueOrDefault

@Derived
public BadDataBehavior onNanValueOrDefault()

Get the behavior for when Double.NaN values are encountered. Defaults to SKIP.

Returns:

the behavior for Double.NaN values

bigValueContextOrDefault

@Derived
public MathContext bigValueContextOrDefault()

Get the MathContext to use when processing BigInteger and BigDecimal values. Defaults to MathContext.DECIMAL128.

Returns:

the MathContext

materialize

public final OperationControl materialize()

Create a new instance with all of the explicit-or-default values from 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.

Returns:

the explicit new instance