Package io.deephaven.api.updateby.spec

Class RollingFormulaSpec

java.lang.Object

io.deephaven.api.updateby.spec.UpdateBySpecBase

io.deephaven.api.updateby.spec.RollingOpSpec

io.deephaven.api.updateby.spec.RollingFormulaSpec

All Implemented Interfaces:

UpdateBySpec

@Immutable
public abstract class RollingFormulaSpec
extends RollingOpSpec

An UpdateBySpec for performing a windowed rolling formula operation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.api.updateby.spec.UpdateBySpec

UpdateBySpec.Visitor<T>

Constructor Summary

Constructors

Constructor	Description
RollingFormulaSpec()

Method Summary

Modifier and Type	Method	Description
final boolean	applicableTo(Class<?> inputType)	Determine if this spec can be applied to the specified type
abstract String	formula()	The formula to use to calculate output values.
static RollingFormulaSpec	of(WindowScale revWindowScale, WindowScale fwdWindowScale, String formula)
static RollingFormulaSpec	of(WindowScale revWindowScale, WindowScale fwdWindowScale, String formula, String paramToken)
static RollingFormulaSpec	of(WindowScale revWindowScale, String formula)
static RollingFormulaSpec	of(WindowScale revWindowScale, String formula, String paramToken)
static RollingFormulaSpec	ofTicks(long revTicks, long fwdTicks, String formula)
static RollingFormulaSpec	ofTicks(long revTicks, long fwdTicks, String formula, String paramToken)
static RollingFormulaSpec	ofTicks(long revTicks, String formula)
static RollingFormulaSpec	ofTicks(long revTicks, String formula, String paramToken)
static RollingFormulaSpec	ofTime(String timestampCol, long revDuration, long fwdDuration, String formula)
static RollingFormulaSpec	ofTime(String timestampCol, long revDuration, long fwdDuration, String formula, String paramToken)
static RollingFormulaSpec	ofTime(String timestampCol, long revDuration, String formula)
static RollingFormulaSpec	ofTime(String timestampCol, long revDuration, String formula, String paramToken)
static RollingFormulaSpec	ofTime(String timestampCol, Duration revDuration, String formula)
static RollingFormulaSpec	ofTime(String timestampCol, Duration revDuration, String formula, String paramToken)
static RollingFormulaSpec	ofTime(String timestampCol, Duration revDuration, Duration fwdDuration, String formula)
static RollingFormulaSpec	ofTime(String timestampCol, Duration revDuration, Duration fwdDuration, String formula, String paramToken)
abstract Optional<String>	paramToken()	Deprecated.
Selectable	selectable()	If paramToken() is not supplied, this will contain a Selectable of the parsed formula().
final <T> T	walk(UpdateBySpec.Visitor<T> visitor)

Methods inherited from class io.deephaven.api.updateby.spec.RollingOpSpec

fwdWindowScale, revWindowScale

Methods inherited from class io.deephaven.api.updateby.spec.UpdateBySpecBase

clause, clause, clause, clause, clause, clause

Methods inherited from class java.lang.Object

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

Constructor Details

RollingFormulaSpec

public RollingFormulaSpec()

Method Details

formula

public abstract String formula()

The formula to use to calculate output values. The formula is similar to TableOperations.update(java.lang.String...) and TableOperations.updateView(java.lang.String...) in specifying the output column name and the expression to compute in terms of the input columns. (e.g. "outputCol = sum(inputColA + inputColB)").

The alternative (and deprecated) form for formula() is active when paramToken() is provided. In this case the formula should only contain the expression in terms of the token. (e.g. sum(x) where x is the paramToken()). NOTE: This form is deprecated and will be removed in a future release.

paramToken

@Deprecated
public abstract Optional<String> paramToken()

Deprecated.

(Deprecated) The token to use in formula() to represent the input column. If this parameter is provided, then only a single input column can be provided in the formula.

ofTicks

public static RollingFormulaSpec ofTicks(long revTicks,
 String formula,
 String paramToken)

ofTicks

public static RollingFormulaSpec ofTicks(long revTicks,
 long fwdTicks,
 String formula,
 String paramToken)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 Duration revDuration,
 String formula,
 String paramToken)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 Duration revDuration,
 Duration fwdDuration,
 String formula,
 String paramToken)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 long revDuration,
 String formula,
 String paramToken)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 long revDuration,
 long fwdDuration,
 String formula,
 String paramToken)

ofTicks

public static RollingFormulaSpec ofTicks(long revTicks,
 String formula)

ofTicks

public static RollingFormulaSpec ofTicks(long revTicks,
 long fwdTicks,
 String formula)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 Duration revDuration,
 String formula)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 Duration revDuration,
 Duration fwdDuration,
 String formula)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 long revDuration,
 String formula)

ofTime

public static RollingFormulaSpec ofTime(String timestampCol,
 long revDuration,
 long fwdDuration,
 String formula)

of

public static RollingFormulaSpec of(WindowScale revWindowScale,
 String formula,
 String paramToken)

of

public static RollingFormulaSpec of(WindowScale revWindowScale,
 WindowScale fwdWindowScale,
 String formula,
 String paramToken)

of

public static RollingFormulaSpec of(WindowScale revWindowScale,
 String formula)

of

public static RollingFormulaSpec of(WindowScale revWindowScale,
 WindowScale fwdWindowScale,
 String formula)

selectable

@Lazy
public Selectable selectable()

If paramToken() is not supplied, this will contain a Selectable of the parsed formula().

applicableTo

public final boolean applicableTo(Class<?> inputType)

Description copied from interface: UpdateBySpec

Determine if this spec can be applied to the specified type

Parameters:

inputType - the specified input type

Returns:

true if this spec can be applied to the specified input type

walk

public final <T> T walk(UpdateBySpec.Visitor<T> visitor)