com.illumon.iris.db.v2.select.AbstractFormulaColumn

All Implemented Interfaces:: FormulaColumn, SelectColumn

Direct Known Subclasses:: DhFormulaColumn, NumbaFormulaColumn

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.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`COLUMN_SUFFIX`
`protected String`	`columnName`
`protected Map<String,? extends ColumnSource>`	`columnSources`
`protected String`	`formulaString`
`protected Param[]`	`params`
`protected Class`	`returnedType`
`protected List<String>`	`usedColumnArrays`
`protected List<String>`	`usedColumns`
`protected List<String>`	`userParams`
`protected boolean`	`usesI`
`protected boolean`	`usesII`
`protected boolean`	`usesK`

Fields inherited from interface com.illumon.iris.db.v2.select.SelectColumn

ZERO_LENGTH_SELECT_COLUMN_ARRAY

Method Summary

Modifier and Type	Method	Description
`protected void`	`applyUsedVariables(Map<String,com.illumon.dataobjects.ColumnDefinition> columnDefinitionMap, Set<String> variablesUsed)`
`protected FormulaFactory`	`createFormulaFactory()`
`boolean`	`disallowRefresh()`	Should we disallow use of this column for refreshing tables? Some formulas can not be reliably computed with a refreshing table, therefore we will refuse to compute those values.
`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.
`ColumnSource`	`getDataView()`	Creates a `ColumnSource` that will evaluate the result of the `formula` for a given row on demand when it is accessed.
`protected abstract FormulaKernelFactory`	`getFormulaKernelFactory()`
`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`	`getReturnedType()`	Get the data type stored in the resultant column.
`protected abstract FormulaSourceDescriptor`	`getSourceDescriptor()`
`List<String>`	`initInputs(Table table)`	Initialize the SelectColumn using the input table and return a list of underlying columns that this SelectColumn is dependent upon.
`List<String>`	`initInputs(Index index, Map<String,? extends ColumnSource> columnsOfInterest)`	Initialize the column from the provided set of underlying columns and index.
`boolean`	`isRetain()`
`static DbArrayBase`	`makeAppropriateDbArrayWrapper(ColumnSource cs, Index index)`
`WritableSource`	`newDestInstance(long size)`	Create a new `WritableSource` with sufficient capacity for the rows in the index.
`String`	`toString()`
`ColumnSource`	`updateData(WritableSource result, long destPos, long sourcePos)`

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.v2.select.FormulaColumn

getFormulaShiftColPair, hasConstantArrayAccess, hasConstantValue

Methods inherited from interface com.illumon.iris.db.v2.select.SelectColumn

alwaysEvaluate, alwaysEvaluateCopy, copy, getConstantValueView, initDef

Field Details
- formulaString
  
  protected String formulaString
- usedColumns
  
  protected List<String> usedColumns
- columnName
  
  @NotNull protected final String columnName
- userParams
  
  protected List<String> userParams
- params
  
  protected Param[] params
- columnSources
  
  protected Map<String,? extends ColumnSource> columnSources
- 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
Method Details
- initInputs
  
  public List<String> initInputs(Table table)
  
  Description copied from interface: SelectColumn
  
  Initialize the SelectColumn using the input table and return a list of underlying columns that this SelectColumn is dependent upon.
  
  Specified by:
  
  initInputs in interface SelectColumn
  
  Parameters:
  
  table - the table to initialize internals from
  
  Returns:
  
  a list containing all columns from 'table' that the result depends on
- 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
- initInputs
  
  public List<String> initInputs(Index index, Map<String,? extends ColumnSource> columnsOfInterest)
  
  Description copied from interface: SelectColumn
  
  Initialize the column from the provided set of underlying columns and index.
  
  Specified by:
  
  initInputs in interface SelectColumn
  
  Parameters:
  
  index - the base index
  
  columnsOfInterest - the input columns
  
  Returns:
  
  a list of columns on which the result of this is dependent
- applyUsedVariables
  
  protected void applyUsedVariables(Map<String,com.illumon.dataobjects.ColumnDefinition> columnDefinitionMap, Set<String> variablesUsed)
- 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
- updateData
  
  public ColumnSource updateData(WritableSource result, long destPos, long sourcePos)
  
  Specified by:
  
  updateData in interface FormulaColumn
- getDataView
  
  @NotNull public 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 Table.updateView(com.illumon.iris.db.v2.select.SelectColumn...) or Table.view(com.illumon.iris.db.v2.select.SelectColumn...) on a Table.
  
  Specified by:
  
  getDataView in interface SelectColumn
  
  Returns:
  
  a ColumnSource
- getLazyView
  
  @NotNull public 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 Table.lazyUpdate(com.illumon.iris.db.v2.select.SelectColumn...) on a Table.
- createFormulaFactory
  
  protected FormulaFactory createFormulaFactory()
- makeAppropriateDbArrayWrapper
  
  public static DbArrayBase makeAppropriateDbArrayWrapper(ColumnSource cs, Index index)
- getSourceDescriptor
  
  protected abstract FormulaSourceDescriptor getSourceDescriptor()
- getFormulaKernelFactory
  
  protected abstract FormulaKernelFactory getFormulaKernelFactory()
- 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:
- isRetain
  
  public boolean isRetain()
  
  Specified by:
  
  isRetain in interface SelectColumn
  
  Returns:
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- newDestInstance
  
  public WritableSource newDestInstance(long size)
  
  Description copied from interface: SelectColumn
  
  Create a new WritableSource with sufficient capacity for the rows in the index.
  
  Specified by:
  
  newDestInstance in interface SelectColumn
  
  Parameters:
  
  size - The number of rows to allocate
  
  Returns:
  
  a new WritableSource with sufficient capacity for 'dataSubset'
- disallowRefresh
  
  public boolean disallowRefresh()
  
  Description copied from interface: SelectColumn
  
  Should we disallow use of this column for refreshing tables? Some formulas can not be reliably computed with a refreshing table, therefore we will refuse to compute those values.
  
  Specified by:
  
  disallowRefresh in interface SelectColumn

Class AbstractFormulaColumn