Package com.illumon.iris.db.v2.updateby

Interface UpdateByClause

All Known Implementing Classes:

ColumnUpdateClause

public interface UpdateByClause

Defines an operation that can be applied to a table with Table.updateBy(Collection, String...)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UpdateByClause.Visitor

Method Summary

Modifier and Type	Method	Description
static UpdateByClause	delta(DeltaControl control, String... columns)	Compute the cell by cell delta values for each column.
static UpdateByClause	delta(String... columns)	Compute the cell by cell delta values for each column.
static UpdateByClause	ema(long timeScaleTicks, EmaControl.Builder control, String... columns)	Create an Exponential Moving Average of the specified columns, using ticks as the decay unit.
static UpdateByClause	ema(long timeScaleTicks, EmaControl control, String... columns)	Create an Exponential Moving Average of the specified columns, using ticks as the decay unit.
static UpdateByClause	ema(String timestampColumn, long timeScaleNanos, EmaControl.Builder control, String... columns)	Create an Exponential Moving Average of the specified columns, using time as the decay unit.
static UpdateByClause	ema(String timestampColumn, long timeScaleNanos, EmaControl control, String... columns)	Create an Exponential Moving Average of the specified columns, using time as the decay unit.
static UpdateByClause	fill(String... columnsToFill)	Create a forward fill operation for the specified columns.
static UpdateByClause	max(String... columns)	Create a Cumulative Maximum of the specified columns.
static UpdateByClause	min(String... columns)	Create a Cumulative Minimum of the specified columns.
static ColumnUpdateClause	of(UpdateBySpec spec, String... columns)	Conjoin an UpdateBySpec with columns for it to be applied to so the engine can construct the proper operators.
static Collection<UpdateByClause>	of(UpdateByClause... operations)	Simply wrap the input specs as a collection suitable for Table.updateBy(UpdateByControl, Collection, MatchPair...).
static UpdateByClause	prod(String... columns)	Create a Cumulative Product of the specified columns.
static UpdateByClause	sum(String... columnsToSum)	Create a forward fill operation for the specified columns.
<V extends UpdateByClause.Visitor> V	walk(V v)

Method Details

of

static ColumnUpdateClause of(@NotNull
 UpdateBySpec spec,
 String... columns)

Conjoin an UpdateBySpec with columns for it to be applied to so the engine can construct the proper operators.

Parameters:

spec - the UpdateBySpec that defines the operation to perform

columns - the columns to apply the operation to.

Returns:

a ColumnUpdateClause that will be used to construct operations for each column

of

static Collection<UpdateByClause> of(@NotNull
 UpdateByClause... operations)

Simply wrap the input specs as a collection suitable for Table.updateBy(UpdateByControl, Collection, MatchPair...). This is functionally equivalent to Arrays.asList(Object[]).

Parameters:

operations - the operations to wrap.

Returns:

a collection for use with Table.updateBy(UpdateByControl, Collection, MatchPair...)

sum

static UpdateByClause sum(String... columnsToSum)

Create a forward fill operation for the specified columns.

Parameters:

columnsToSum - the columns to fill.

Returns:

a new UpdateByClause for performing a forward fill with Table.updateBy(UpdateByControl, Collection, MatchPair...)

fill

static UpdateByClause fill(String... columnsToFill)

Create a forward fill operation for the specified columns.

Parameters:

columnsToFill - the columns to fill.

Returns:

a new UpdateByClause for performing a forward fill with Table.updateBy(UpdateByControl, Collection, MatchPair...)

min

static UpdateByClause min(String... columns)

Create a Cumulative Minimum of the specified columns.

Parameters:

columns - the columns to find the min

Returns:

a new UpdateByClause for performing a cumulative min with Table.updateBy(UpdateByControl, Collection, MatchPair...)

max

static UpdateByClause max(String... columns)

Create a Cumulative Maximum of the specified columns.

Parameters:

columns - the columns to find the min

Returns:

a new UpdateByClause for performing a cumulative max with Table.updateBy(UpdateByControl, Collection, MatchPair...)

prod

static UpdateByClause prod(String... columns)

Create a Cumulative Product of the specified columns.

Parameters:

columns - the columns to find the min

Returns:

a new UpdateByClause for performing a cumulative produce with Table.updateBy(UpdateByControl, Collection, MatchPair...)

ema

static UpdateByClause ema(long timeScaleTicks,
 @NotNull
 EmaControl.Builder control,
 String... columns)

Create an Exponential Moving Average of the specified columns, using ticks as the decay unit.

The formula used is

     a = e^(-1 / timeScaleTicks)
     ema_next = a * ema_last + (1 - a) * value
 

Parameters:

timeScaleTicks - the decay rate (tau) in ticks

control - a control object that defines how special cases should behave. See EmaControl for further details.

columns - the columns to apply the EMA to.

Returns:

a new UpdateByClause for performing an EMA with Table.updateBy(UpdateByControl, Collection, MatchPair...)

ema

static UpdateByClause ema(long timeScaleTicks,
 @NotNull
 EmaControl control,
 String... columns)

Create an Exponential Moving Average of the specified columns, using ticks as the decay unit.

The formula used is

     a = e^(-1 / timeScaleTicks)
     ema_next = a * ema_last + (1 - a) * value
 

Parameters:

timeScaleTicks - the decay rate (tau) in ticks

control - a control object that defines how special cases should behave. See EmaControl for further details.

columns - the columns to apply the EMA to.

Returns:

a new UpdateByClause for performing an EMA with Table.updateBy(UpdateByControl, Collection, MatchPair...)

ema

static UpdateByClause ema(@NotNull
 String timestampColumn,
 long timeScaleNanos,
 @NotNull
 EmaControl.Builder control,
 String... columns)

Create an Exponential Moving Average of the specified columns, using time as the decay unit.

The formula used is

     a = e^(-dt / timeScaleNanos)
     ema_next = a * ema_last + (1 - a) * value
 

Parameters:

timestampColumn - the column in the source table to use for timestamps

timeScaleNanos - the decay rate (tau) in nanoseconds

control - a control object that defines how special cases should behave. See EmaControl for further details.

columns - the columns to apply the EMA to.

Returns:

a new UpdateByClause for performing an EMA with Table.updateBy(UpdateByControl, Collection, MatchPair...)

ema

static UpdateByClause ema(@NotNull
 String timestampColumn,
 long timeScaleNanos,
 @NotNull
 EmaControl control,
 String... columns)

Create an Exponential Moving Average of the specified columns, using time as the decay unit.

The formula used is

     a = e^(-dt / timeScaleNanos)
     ema_next = a * ema_last + (1 - a) * value
 

Parameters:

timestampColumn - the column in the source table to use for timestamps

timeScaleNanos - the decay rate (tau) in nanoseconds

control - a control object that defines how special cases should behave. See EmaControl for further details.

columns - the columns to apply the EMA to.

Returns:

a new UpdateByClause for performing an EMA with Table.updateBy(UpdateByControl, Collection, MatchPair...)

delta

static UpdateByClause delta(String... columns)

Compute the cell by cell delta values for each column. Result columns maintain the same type as the original, with the exception of timestamps which represent the difference in nanoseconds.

Parameters:

columns - the columns to compute deltas for

Returns:

a new UpdateByClause for performing a delta operation with Table.updateBy(UpdateByControl, Collection, MatchPair...)

delta

static UpdateByClause delta(@NotNull
 DeltaControl control,
 String... columns)

Compute the cell by cell delta values for each column. Result columns maintain the same type as the original, with the exception of timestamps which represent the difference in nanoseconds.

Parameters:

control - the DeltaControl object to control the behavior when null values are encountered

columns - the columns to compute deltas for

Returns:

a new UpdateByClause for performing a delta operation with Table.updateBy(UpdateByControl, Collection, MatchPair...)

walk

<V extends UpdateByClause.Visitor> V walk(@NotNull
 V v)