Package io.deephaven.engine.table.impl.select

Interface FormulaColumn

All Superinterfaces:

ConcurrencyControl<Selectable>, Selectable, SelectColumn

All Known Implementing Classes:

AbstractFormulaColumn, DhFormulaColumn, FormulaColumnPython

public interface FormulaColumn
extends SelectColumn

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.select.SelectColumn

SelectColumn.ExpressionAdapter

Field Summary

Fields inherited from interface io.deephaven.engine.table.impl.select.SelectColumn

ZERO_LENGTH_SELECT_COLUMN_ARRAY

Method Summary

Modifier and Type	Method	Description
static FormulaColumn	createFormulaColumn(String columnName, String formulaString)
static FormulaColumn	createFormulaColumn(String columnName, String formulaString, FormulaParserConfiguration parser)
default Set<ShiftedColumnDefinition>	getFormulaShiftedColumnDefinitions()	Returns a Set of ShiftedColumnDefinitions.
default String	getShiftedFormulaString()	Returns a String representation of the formula expression with the shifted column names replaced by the corresponding ShiftedColumnDefinition.getResultColumnName() values.
default boolean	hasConstantArrayAccess()	Returns true if the formula expression of the column has Array Access that conforms to "i +/- <constant>" or "ii +/- <constant>".
default boolean	hasConstantValue()
default Optional<FormulaColumn>	maybeGetFormulaColumn()

Methods inherited from interface io.deephaven.api.Selectable

declaredBarriers, isSerial, respectedBarriers

Methods inherited from interface io.deephaven.engine.table.impl.select.SelectColumn

copy, expression, getColumnArrays, getColumns, getDataView, getLazyView, getMatchPair, getName, getReturnedComponentType, getReturnedType, hasVirtualRowVariables, initDef, initDef, initInputs, isRetain, isStateless, maybeGetSourceColumn, newColumn, newDestInstance, newFlatDestInstance, recomputeOnModifiedRow, validateSafeForRefresh, withDeclaredBarriers, withRecomputeOnModifiedRow, withRespectedBarriers, withSerial

Method Details

createFormulaColumn

static FormulaColumn createFormulaColumn(String columnName,
 String formulaString,
 FormulaParserConfiguration parser)

createFormulaColumn

static FormulaColumn createFormulaColumn(String columnName,
 String formulaString)

hasConstantValue

default boolean hasConstantValue()

Specified by:

hasConstantValue in interface SelectColumn

Returns:

true if all rows have a single constant value

hasConstantArrayAccess

default boolean hasConstantArrayAccess()

Returns true if the formula expression of the column has Array Access that conforms to "i +/- <constant>" or "ii +/- <constant>".

Specified by:

hasConstantArrayAccess in interface SelectColumn

Returns:

true or false

getFormulaShiftedColumnDefinitions

default Set<ShiftedColumnDefinition> getFormulaShiftedColumnDefinitions()

Returns a Set of ShiftedColumnDefinitions. If the column formula or expression has Array Access that conforms to "i +/- <constant>" or "ii +/- <constant>". If there is a parsing error for the expression, this method's result is undefined.

Returns:

the Set of ShiftedColumnDefinitions or null if there is no constant array access

getShiftedFormulaString

default String getShiftedFormulaString()

Returns a String representation of the formula expression with the shifted column names replaced by the corresponding ShiftedColumnDefinition.getResultColumnName() values.

Returns:

the shifted formula string or null if there is no constant array access

maybeGetFormulaColumn

default Optional<FormulaColumn> maybeGetFormulaColumn()

Specified by:

maybeGetFormulaColumn in interface SelectColumn