com.illumon.iris.db.v2.by

Class IterativeColumnOperator<INPUT_TYPE,OUTPUT_TYPE,STATE>

java.lang.Object

com.illumon.iris.db.v2.by.IterativeColumnOperator<INPUT_TYPE,OUTPUT_TYPE,STATE>

public abstract class IterativeColumnOperator<INPUT_TYPE,OUTPUT_TYPE,STATE>
extends Object

Iterative Operator from Columns of INPUT_TYPE to OUTPUT_TYPE, using STATE to accumulate values that can not be stored in the destination column itself.

Constructor Summary

Constructors

Constructor and Description
IterativeColumnOperator()

Method Summary

Modifier and Type	Method and Description
abstract STATE	add(WritableSource<OUTPUT_TYPE> destColumn, ColumnSource<INPUT_TYPE> columnSource, long destPos, long sourcePos, STATE state) Adds items to the group.
abstract void	modify(WritableSource<OUTPUT_TYPE> destColumn, ColumnSource<INPUT_TYPE> columnSource, long destPos, long sourcePos, STATE state) Modifies an existing row within the state.
abstract void	remove(WritableSource<OUTPUT_TYPE> destColumn, ColumnSource<INPUT_TYPE> columnSource, long destPos, long sourcePos, STATE state) Removes an existing row from the state state.
abstract void	validate(Index index, ColumnSource<INPUT_TYPE> source, WritableSource<OUTPUT_TYPE> destColumn, long rowNumber)

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeColumnOperator

public IterativeColumnOperator()

Method Detail

add

public abstract STATE add(WritableSource<OUTPUT_TYPE> destColumn,
                          ColumnSource<INPUT_TYPE> columnSource,
                          long destPos,
                          long sourcePos,
                          STATE state)

Adds items to the group. If state is null; and required then the add call is expected to create it and return it. Otherwise the updated state is returned. The state can remain null, e.g., if the destination column can store all of the required state.

Parameters:

destColumn - the destination (output) column

columnSource - the source (input) column

destPos - the key within the destColumn to update

sourcePos - the key within the columnSource to read

state - the state for this group

modify

public abstract void modify(WritableSource<OUTPUT_TYPE> destColumn,
                            ColumnSource<INPUT_TYPE> columnSource,
                            long destPos,
                            long sourcePos,
                            STATE state)

Modifies an existing row within the state.

Parameters:

destColumn - the destination (output) column

columnSource - the source (input) column

destPos - the key within the destColumn to update

sourcePos - the key within the columnSource to read

state - the state for this group

remove

public abstract void remove(WritableSource<OUTPUT_TYPE> destColumn,
                            ColumnSource<INPUT_TYPE> columnSource,
                            long destPos,
                            long sourcePos,
                            STATE state)

Removes an existing row from the state state.

Parameters:

destColumn - the destination (output) column

columnSource - the source (input) column

destPos - the key within the destColumn to update

sourcePos - the key within the columnSource to read

state - the state for this group

validate

public abstract void validate(Index index,
                              ColumnSource<INPUT_TYPE> source,
                              WritableSource<OUTPUT_TYPE> destColumn,
                              long rowNumber)