Package io.deephaven.engine.table.impl.updateby.rollinggroup

Class RollingGroupOperator

java.lang.Object

io.deephaven.engine.table.impl.updateby.UpdateByOperator

io.deephaven.engine.table.impl.updateby.rollinggroup.RollingGroupOperator

public class RollingGroupOperator
extends UpdateByOperator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RollingGroupOperator.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected WritableColumnSource<Long>	endSource
protected WritableColumnSource<? extends RowSet>	groupRowSetSource	Store a mapping from row keys to bucket RowSets
protected LongArraySource	innerEndSource
protected ObjectArraySource<? extends RowSet>	innerGroupRowSetSource
protected LongArraySource	innerStartSource
protected WritableColumnSource<Long>	startSource	These sources will retain the position offsets from the current row position for the source and end of this window.

Fields inherited from class io.deephaven.engine.table.impl.updateby.UpdateByOperator

affectingColumns, forwardWindowScaleUnits, inputModifiedColumnSet, isWindowed, outputModifiedColumnSet, pair, reverseWindowScaleUnits, rowRedirection, timestampColumnName

Constructor Summary

Constructors

Modifier	Constructor	Description
	RollingGroupOperator(@NotNull MatchPair[] pairs, @NotNull String[] affectingColumns, @Nullable String timestampColumnName, long reverseWindowScaleUnits, long forwardWindowScaleUnits, @NotNull TableDefinition tableDef)
protected	RollingGroupOperator(@NotNull MatchPair[] pairs, @NotNull String[] affectingColumns, @Nullable String timestampColumnName, long reverseWindowScaleUnits, long forwardWindowScaleUnits, @NotNull String[] inputColumnNames, @NotNull String[] outputColumnNames)

Method Summary

Modifier and Type	Method	Description
void	applyOutputShift(@NotNull RowSet subRowSetToShift, long delta)	Apply a shift to the operation.
void	clearOutputRows(RowSet toClear)	Clear the output rows by setting value to NULL.
UpdateByOperator	copy()	Create an uninitialized copy of this operator.
protected void	createInputModifiedColumnSet(@NotNull QueryTable source)	Create the modified column set for the input columns of this operator.
protected void	createOutputModifiedColumnSet(@NotNull QueryTable result)	Create the modified column set for the output columns from this operator.
protected void	extractDownstreamModifiedColumnSet(@NotNull TableUpdate upstream, @NotNull TableUpdate downstream)	Set the downstream modified column set appropriately for this operator.
protected @NotNull String[]	getInputColumnNames()	Get the names of the input column(s) for this operator.
protected @NotNull String[]	getOutputColumnNames()	Get an array of the output column names.
@NotNull Map<String,ColumnSource<?>>	getOutputColumns()	Get a map of outputName to output ColumnSource for this operation.
void	initializeRolling(UpdateByOperator.Context context, @NotNull RowSet bucketRowSet)	Initialize the bucket context for a windowed operator
void	initializeSources(@NotNull Table source, @Nullable RowRedirection rowRedirection)	Initialize this operator with a specific source table (and row redirection if needed).
UpdateByOperator.Context	makeUpdateContext(int chunkSize, int influencerChunkSize)	Make an UpdateByOperator.Context suitable for use with updates.
void	prepareForParallelPopulation(RowSet changedRows)	Prepare this operator output column for parallel updated.
protected boolean	requiresRowPositions()	Return whether the operator needs affected and influencer row positions during accumulation.
void	startTrackingPrev()	Indicate that the operation should start tracking previous values for ticking updates.

Methods inherited from class io.deephaven.engine.table.impl.updateby.UpdateByOperator

finishUpdate, getAffectingColumnNames, getFwdWindowUnits, getInputModifiedColumnSet, getOutputModifiedColumnSet, getPrevWindowUnits, getTimestampColumnName, initializeCumulative

Methods inherited from class java.lang.Object

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

Field Details

groupRowSetSource

protected WritableColumnSource<? extends RowSet> groupRowSetSource

Store a mapping from row keys to bucket RowSets

innerGroupRowSetSource

protected ObjectArraySource<? extends RowSet> innerGroupRowSetSource

startSource

protected WritableColumnSource<Long> startSource

These sources will retain the position offsets from the current row position for the source and end of this window. A primary benefit of storing offsets in position space vs. row keys is eliminating the need to shift keys stored inside these column sources. Also, any insertion/modification/remove that occurs within this specified window will trigger re-computation of these position offsets.

NOTE: these offsets are inclusive and are stored as simple relative positions where start==0 or end==0 implies the current row is included in the window. A start/end range of [-5,-3] defines a window including exactly 3 rows beginning 5 rows earlier than this one and continuing through 3 rows earlier than this (inclusive). A range of [0,0] contains exactly the current row.

innerStartSource

protected LongArraySource innerStartSource

endSource

protected WritableColumnSource<Long> endSource

innerEndSource

protected LongArraySource innerEndSource

Constructor Details

RollingGroupOperator

public RollingGroupOperator(@NotNull
 @NotNull MatchPair[] pairs,
 @NotNull
 @NotNull String[] affectingColumns,
 @Nullable
 @Nullable String timestampColumnName,
 long reverseWindowScaleUnits,
 long forwardWindowScaleUnits,
 @NotNull
 @NotNull TableDefinition tableDef)

RollingGroupOperator

protected RollingGroupOperator(@NotNull
 @NotNull MatchPair[] pairs,
 @NotNull
 @NotNull String[] affectingColumns,
 @Nullable
 @Nullable String timestampColumnName,
 long reverseWindowScaleUnits,
 long forwardWindowScaleUnits,
 @NotNull
 @NotNull String[] inputColumnNames,
 @NotNull
 @NotNull String[] outputColumnNames)

Method Details

copy

public UpdateByOperator copy()

Description copied from class: UpdateByOperator

Create an uninitialized copy of this operator. UpdateByOperator.initializeSources(Table, RowRedirection) must be called before this operator can be used.

Specified by:

copy in class UpdateByOperator

Returns:

a copy of this operator

initializeSources

public void initializeSources(@NotNull
 @NotNull Table source,
 @Nullable
 @Nullable RowRedirection rowRedirection)

Description copied from class: UpdateByOperator

Initialize this operator with a specific source table (and row redirection if needed). This will be called exactly once per operator.

Specified by:

initializeSources in class UpdateByOperator

makeUpdateContext

@NotNull
public UpdateByOperator.Context makeUpdateContext(int chunkSize,
 int influencerChunkSize)

Description copied from class: UpdateByOperator

Make an UpdateByOperator.Context suitable for use with updates.

Specified by:

makeUpdateContext in class UpdateByOperator

Parameters:

chunkSize - The maximum size of affected chunks that will be provided during the update.

influencerChunkSize - The maximum size of influencer chunks that will be provided during the update.

Returns:

a new context

prepareForParallelPopulation

public void prepareForParallelPopulation(RowSet changedRows)

Description copied from class: UpdateByOperator

Prepare this operator output column for parallel updated.

Specified by:

prepareForParallelPopulation in class UpdateByOperator

initializeRolling

public void initializeRolling(@NotNull
 UpdateByOperator.Context context,
 @NotNull
 @NotNull RowSet bucketRowSet)

Description copied from class: UpdateByOperator

Initialize the bucket context for a windowed operator

Overrides:

initializeRolling in class UpdateByOperator

applyOutputShift

public void applyOutputShift(@NotNull
 @NotNull RowSet subRowSetToShift,
 long delta)

Description copied from class: UpdateByOperator

Apply a shift to the operation.

Specified by:

applyOutputShift in class UpdateByOperator

clearOutputRows

public void clearOutputRows(RowSet toClear)

Description copied from class: UpdateByOperator

Clear the output rows by setting value to NULL. Dense sources will apply removes to the inner source.

Specified by:

clearOutputRows in class UpdateByOperator

startTrackingPrev

public void startTrackingPrev()

Description copied from class: UpdateByOperator

Indicate that the operation should start tracking previous values for ticking updates.

Specified by:

startTrackingPrev in class UpdateByOperator

getOutputColumnNames

@NotNull
protected @NotNull String[] getOutputColumnNames()

Get an array of the output column names.

Overrides:

getOutputColumnNames in class UpdateByOperator

Returns:

the output column names.

getOutputColumns

@NotNull
public @NotNull Map<String,ColumnSource<?>> getOutputColumns()

Get a map of outputName to output ColumnSource for this operation.

Specified by:

getOutputColumns in class UpdateByOperator

Returns:

a map of output column name to output column source

getInputColumnNames

@NotNull
protected @NotNull String[] getInputColumnNames()

Get the names of the input column(s) for this operator.

Overrides:

getInputColumnNames in class UpdateByOperator

Returns:

the names of the input column

requiresRowPositions

protected boolean requiresRowPositions()

Return whether the operator needs affected and influencer row positions during accumulation. RollingGroup sets this to true.

Overrides:

requiresRowPositions in class UpdateByOperator

createInputModifiedColumnSet

protected void createInputModifiedColumnSet(@NotNull
 @NotNull QueryTable source)

Create the modified column set for the input columns of this operator.

Overrides:

createInputModifiedColumnSet in class UpdateByOperator

createOutputModifiedColumnSet

protected void createOutputModifiedColumnSet(@NotNull
 @NotNull QueryTable result)

Create the modified column set for the output columns from this operator.

Overrides:

createOutputModifiedColumnSet in class UpdateByOperator

extractDownstreamModifiedColumnSet

protected void extractDownstreamModifiedColumnSet(@NotNull
 @NotNull TableUpdate upstream,
 @NotNull
 @NotNull TableUpdate downstream)

Set the downstream modified column set appropriately for this operator.

Overrides:

extractDownstreamModifiedColumnSet in class UpdateByOperator