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

Class AbstractFormulaColumn

java.lang.Object

io.deephaven.engine.table.impl.select.AbstractFormulaColumn

All Implemented Interfaces:

ConcurrencyControl<Selectable>, Selectable, FormulaColumn, SelectColumn

Direct Known Subclasses:

DhFormulaColumn, FormulaColumnPython

public abstract class AbstractFormulaColumn
extends Object
implements FormulaColumn

A SelectColumn that implements a formula computed from the existing columns in the table and a query scope.

Nested Class Summary

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

SelectColumn.ExpressionAdapter

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	ALLOW_UNSAFE_REFRESHING_FORMULAS
static final String	COLUMN_SUFFIX
protected Map<String,ColumnDefinition<?>>	columnDefinitions
protected final @NotNull String	columnName
protected Map<String,? extends ColumnSource<?>>	columnSources
protected Future<FormulaFactory>	formulaFactoryFuture
protected String	formulaString
protected final String	originalFormulaString
protected QueryScopeParam<?>[]	params
protected Class<?>	returnedType
protected List<String>	usedColumnArrays
protected List<String>	usedColumns
protected boolean	usesI
protected boolean	usesII
protected boolean	usesK

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

ZERO_LENGTH_SELECT_COLUMN_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFormulaColumn(String columnName, String formulaString)	Create a formula column for the given formula string.

Method Summary

Modifier and Type	Method	Description
protected void	applyUsedVariables(@NotNull Map<String,ColumnDefinition<?>> parentColumnDefinitions, @NotNull Set<String> variablesUsed, @NotNull Map<String,Object> possibleParams)
protected Future<FormulaFactory>	createKernelFormulaFactory(@NotNull CompletionStageFuture<FormulaKernelFactory> formulaKernelFactoryFuture)
List<String>	getColumnArrays()	Get a list of the names of column arrays used in this SelectColumn.
List<String>	getColumns()	Get a list of the names of columns used in this SelectColumn.
@NotNull ColumnSource<?>	getDataView()	Creates a ColumnSource that will evaluate the result of the formula for a given row on demand when it is accessed.
@NotNull ColumnSource<?>	getLazyView()	Creates a ColumnSource that will evaluate the result of the formula for a given row on demand when it is accessed and cache the result
MatchPair	getMatchPair()	Get a MatchPair for this column, if applicable.
String	getName()	Get the name of the resultant column.
Class<?>	getReturnedComponentType()	Get the data component type stored in the resultant column.
Class<?>	getReturnedType()	Get the data type stored in the resultant column.
protected abstract FormulaSourceDescriptor	getSourceDescriptor()
boolean	hasVirtualRowVariables()	Returns true if this column uses row virtual offset columns of i, ii or k.
List<String>	initInputs(@NotNull TrackingRowSet rowSet, @NotNull Map<String,? extends ColumnSource<?>> columnsOfInterest)	Initialize the column from the provided set of underlying columns and row set.
boolean	isRetain()
WritableColumnSource<?>	newDestInstance(long size)	Create a new WritableColumnSource.
WritableColumnSource<?>	newFlatDestInstance(long size)	Create a new immutable WritableColumnSource.
protected void	onCopy(AbstractFormulaColumn copy)
String	toString()
protected void	validateColumnDefinition(Map<String,ColumnDefinition<?>> columnDefinitionMap)
void	validateSafeForRefresh(BaseTable<?> sourceTable)	Validate that this SelectColumn is safe to use in the context of the provided sourceTable.

Methods inherited from class java.lang.Object

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

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

getFormulaShiftedColumnDefinitions, getShiftedFormulaString, hasConstantArrayAccess, hasConstantValue, 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, initDef, initDef, isParallelizable, isStateless, maybeGetSourceColumn, newColumn, recomputeOnModifiedRow, withDeclaredBarriers, withRecomputeOnModifiedRow, withRespectedBarriers, withSerial

Field Details

ALLOW_UNSAFE_REFRESHING_FORMULAS

public static final boolean ALLOW_UNSAFE_REFRESHING_FORMULAS

formulaString

protected String formulaString

originalFormulaString

protected final String originalFormulaString

usedColumns

protected List<String> usedColumns

columnName

@NotNull
protected final @NotNull String columnName

formulaFactoryFuture

protected Future<FormulaFactory> formulaFactoryFuture

params

protected QueryScopeParam<?>[] params

columnSources

protected Map<String,? extends ColumnSource<?>> columnSources

columnDefinitions

protected Map<String,ColumnDefinition<?>> columnDefinitions

returnedType

protected Class<?> returnedType

COLUMN_SUFFIX

public static final String COLUMN_SUFFIX

See Also:

• Constant Field Values

usedColumnArrays

protected List<String> usedColumnArrays

usesI

protected boolean usesI

usesII

protected boolean usesII

usesK

protected boolean usesK

Constructor Details

AbstractFormulaColumn

protected AbstractFormulaColumn(String columnName,
 String formulaString)

Create a formula column for the given formula string.

The internal formula object is generated on-demand by calling out to the Java compiler.

Parameters:

columnName - the result column name

formulaString - the formula string to be parsed by the QueryLanguageParser

Method Details

getReturnedType

public Class<?> getReturnedType()

Description copied from interface: SelectColumn

Get the data type stored in the resultant column.

Specified by:

getReturnedType in interface SelectColumn

Returns:

the type

getReturnedComponentType

public Class<?> getReturnedComponentType()

Description copied from interface: SelectColumn

Get the data component type stored in the resultant column.

Specified by:

getReturnedComponentType in interface SelectColumn

Returns:

the component type

initInputs

public List<String> initInputs(@NotNull
 @NotNull TrackingRowSet rowSet,
 @NotNull
 @NotNull Map<String,? extends ColumnSource<?>> columnsOfInterest)

Description copied from interface: SelectColumn

Initialize the column from the provided set of underlying columns and row set.

Specified by:

initInputs in interface SelectColumn

Parameters:

rowSet - the base row set

columnsOfInterest - the input columns

Returns:

a list of columns on which the result of this is dependent

validateSafeForRefresh

public void validateSafeForRefresh(BaseTable<?> sourceTable)

Description copied from interface: SelectColumn

Validate that this SelectColumn is safe to use in the context of the provided sourceTable.

Specified by:

validateSafeForRefresh in interface SelectColumn

Parameters:

sourceTable - the source table

applyUsedVariables

protected void applyUsedVariables(@NotNull
 @NotNull Map<String,ColumnDefinition<?>> parentColumnDefinitions,
 @NotNull
 @NotNull Set<String> variablesUsed,
 @NotNull
 @NotNull Map<String,Object> possibleParams)

onCopy

protected void onCopy(AbstractFormulaColumn copy)

validateColumnDefinition

protected void validateColumnDefinition(Map<String,ColumnDefinition<?>> columnDefinitionMap)

getColumns

public List<String> getColumns()

Description copied from interface: SelectColumn

Get a list of the names of columns used in this SelectColumn. Behavior is undefined if none of the init* methods have been called yet.

Specified by:

getColumns in interface SelectColumn

Returns:

the columns used in this SelectColumn

getColumnArrays

public List<String> getColumnArrays()

Description copied from interface: SelectColumn

Get a list of the names of column arrays used in this SelectColumn. Behavior is undefined if none of the init* methods have been called yet.

Specified by:

getColumnArrays in interface SelectColumn

Returns:

the list of column arrays used

getDataView

@NotNull
public @NotNull ColumnSource<?> getDataView()

Creates a ColumnSource that will evaluate the result of the formula for a given row on demand when it is accessed.

The result of this is the column source produced by calling TableOperations.updateView(java.lang.String...) or TableOperations.view(java.lang.String...) on a Table.

Specified by:

getDataView in interface SelectColumn

Returns:

a ColumnSource

getLazyView

@NotNull
public @NotNull ColumnSource<?> getLazyView()

Creates a ColumnSource that will evaluate the result of the formula for a given row on demand when it is accessed and cache the result

Specified by:

getLazyView in interface SelectColumn

Returns:

the column source produced by calling TableOperations.lazyUpdate(java.lang.String...) on a Table.

createKernelFormulaFactory

protected Future<FormulaFactory> createKernelFormulaFactory(@NotNull
 @NotNull CompletionStageFuture<FormulaKernelFactory> formulaKernelFactoryFuture)

getSourceDescriptor

protected abstract FormulaSourceDescriptor getSourceDescriptor()

getName

public String getName()

Description copied from interface: SelectColumn

Get the name of the resultant column.

Specified by:

getName in interface SelectColumn

Returns:

the name of the column

getMatchPair

public MatchPair getMatchPair()

Description copied from interface: SelectColumn

Get a MatchPair for this column, if applicable.

Specified by:

getMatchPair in interface SelectColumn

Returns:

the MatchPair for this column, if applicable.

isRetain

public boolean isRetain()

Specified by:

isRetain in interface SelectColumn

Returns:

true if this SelectColumn is retaining an existing column unchanged

hasVirtualRowVariables

public boolean hasVirtualRowVariables()

Description copied from interface: SelectColumn

Returns true if this column uses row virtual offset columns of i, ii or k.

Specified by:

hasVirtualRowVariables in interface SelectColumn

toString

public String toString()

Overrides:

toString in class Object

newDestInstance

public WritableColumnSource<?> newDestInstance(long size)

Description copied from interface: SelectColumn

Create a new WritableColumnSource. The returned column source must be capable of handling updates.

Specified by:

newDestInstance in interface SelectColumn

Parameters:

size - A hint as to the number of rows that will be used

Returns:

a new WritableColumnSource

newFlatDestInstance

public WritableColumnSource<?> newFlatDestInstance(long size)

Description copied from interface: SelectColumn

Create a new immutable WritableColumnSource. The returned column source should be flat, and need not handle updates.

Specified by:

newFlatDestInstance in interface SelectColumn

Parameters:

size - A hint as to the number of rows that will be used

Returns:

a new WritableColumnSource