com.rpl.rama

Interface Agg

All Superinterfaces:

AggOrCompoundAgg

All Known Subinterfaces:

TopMonotonicAgg

public interface Agg
extends AggOrCompoundAgg

Used for specifying aggregators in Rama topologies in conjunction with agg or compoundAgg methods

See Also:

Aggregator documentation

Method Summary

Modifier and Type	Method and Description
static Agg	accumulator(RamaAccumulatorAgg0 accumulator) Use a custom accumulator of zero arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg1 accumulator, java.lang.Object arg0) Use a custom accumulator of one argument as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg2 accumulator, java.lang.Object arg0, java.lang.Object arg1) Use a custom accumulator of two arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg3 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2) Use a custom accumulator of three arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg4 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Use a custom accumulator of four arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg5 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Use a custom accumulator of five arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg6 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Use a custom accumulator of six arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg7 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6) Use a custom accumulator of seven arguments as an aggregator.
static Agg	accumulator(RamaAccumulatorAgg8 accumulator, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7) Use a custom accumulator of eight arguments as an aggregator.
static Agg	and(java.lang.Object arg) Applies "and" operator to all input.
static Agg	average(java.lang.Object arg) Averages input into a java.lang.Long.
Agg	captureNewValInto(java.lang.String var) Captures updated value of aggregated location into var for post-agg phase of a batch block.
static Agg	combiner(RamaCombinerAgg combiner, java.lang.Object arg) Use a custom combiner as an aggregator
static Agg	count() Counts input into a java.lang.Long
static Agg	first(java.lang.Object arg) Aggregates input to the first input seen
static Agg	last(java.lang.Object arg) Aggregates input to the last input seen
static Agg	list(java.lang.Object arg) Aggregates all input to a java.util.List data structure.
static Agg	map(java.lang.Object argKey, java.lang.Object argVal) Aggregates all input to a java.util.Map data structure.
static Agg	max(java.lang.Object arg) Computes maximum value from input
static Agg	mergeMap(java.lang.Object arg) Aggregates input java.util.Maps together into a single java.util.Map by adding all key/value pairs of each input.
static Agg	min(java.lang.Object arg) Computes minimum value from input
static Agg	multiSet(java.lang.Object arg) Aggregates input values into a java.util.Map from value to count
static Agg	or(java.lang.Object arg) Applies "or" operator to all input.
static Agg	set(java.lang.Object arg) Aggregates all input to a java.util.Set data structure.
static Agg	setRemove(java.lang.Object arg) Aggregates to "void" value for the given java.util.Set element.
static Agg	sum(java.lang.Object arg) Sums input values into a java.lang.Long
static TopMonotonicAgg	topMonotonic(int amt, java.lang.String var) Aggregates input into a list of top elements.
static Agg	voided() Aggregates to "void" value.

Method Detail

captureNewValInto

Agg captureNewValInto(java.lang.String var)

Captures updated value of aggregated location into var for post-agg phase of a batch block. Used with compoundAgg and only usable in batch blocks in microbatch topologies.

Parameters:

var - Var to capture

See Also:

Detailed captureNewValInto documentation

sum

static Agg sum(java.lang.Object arg)

Sums input values into a java.lang.Long

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

count

static Agg count()

Counts input into a java.lang.Long

Returns:

Builder-style object to add options

average

static Agg average(java.lang.Object arg)

Averages input into a java.lang.Long. Cannot be used for aggregation into an existing PState.

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

max

static Agg max(java.lang.Object arg)

Computes maximum value from input

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

min

static Agg min(java.lang.Object arg)

Computes minimum value from input

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

or

static Agg or(java.lang.Object arg)

Applies "or" operator to all input. Null or boolean false values are considered "false", and all other values are considered "true". If any input is "true", aggregates to first "true" value seen. If all inputs are "false", aggregates to last "false" value seen. If no input, aggregates to boolean false.

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

and

static Agg and(java.lang.Object arg)

Applies "and" operator to all input. Null or false values are considered "false", and all other values are considered "true". If all inputs are "true", aggregates to last "true" value seen. If any input is "false", aggregates to first "false" value seen. If no input, aggregates to boolean true.

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

voided

static Agg voided()

Aggregates to "void" value. Used to remove nested elements from existing PStates.

list

static Agg list(java.lang.Object arg)

Aggregates all input to a java.util.List data structure.

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

set

static Agg set(java.lang.Object arg)

Aggregates all input to a java.util.Set data structure.

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

map

static Agg map(java.lang.Object argKey,
               java.lang.Object argVal)

Aggregates all input to a java.util.Map data structure.

Parameters:

argKey - Value or var input for the key of an entry

argVal - Value or var input for the value of an entry

Returns:

Builder-style object to add options

mergeMap

static Agg mergeMap(java.lang.Object arg)

Aggregates input java.util.Maps together into a single java.util.Map by adding all key/value pairs of each input.

Parameters:

arg - Value or var input that must be a java.util.Map

Returns:

Builder-style object to add options

setRemove

static Agg setRemove(java.lang.Object arg)

Aggregates to "void" value for the given java.util.Set element. Used to remove elements from Sets inside existing PStates.

multiSet

static Agg multiSet(java.lang.Object arg)

Aggregates input values into a java.util.Map from value to count

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

last

static Agg last(java.lang.Object arg)

Aggregates input to the last input seen

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

first

static Agg first(java.lang.Object arg)

Aggregates input to the first input seen

Parameters:

arg - Value or var input

Returns:

Builder-style object to add options

topMonotonic

static TopMonotonicAgg topMonotonic(int amt,
                                    java.lang.String var)

Aggregates input into a list of top elements. See this documentation page for more information.

Parameters:

amt - Number of elements to compute

var - Var input

Returns:

Builder-style object to add sorting and other options

combiner

static Agg combiner(RamaCombinerAgg combiner,
                    java.lang.Object arg)

Use a custom combiner as an aggregator

Parameters:

combiner - Custom combiner implementation

arg - Value or var input

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg0 accumulator)

Use a custom accumulator of zero arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg1 accumulator,
                       java.lang.Object arg0)

Use a custom accumulator of one argument as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg2 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1)

Use a custom accumulator of two arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg3 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2)

Use a custom accumulator of three arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg4 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3)

Use a custom accumulator of four arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg5 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4)

Use a custom accumulator of five arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg6 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4,
                       java.lang.Object arg5)

Use a custom accumulator of six arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg7 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4,
                       java.lang.Object arg5,
                       java.lang.Object arg6)

Use a custom accumulator of seven arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options

accumulator

static Agg accumulator(RamaAccumulatorAgg8 accumulator,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4,
                       java.lang.Object arg5,
                       java.lang.Object arg6,
                       java.lang.Object arg7)

Use a custom accumulator of eight arguments as an aggregator. Arguments can be values or vars.

Parameters:

accumulator - Custom accumulator implementation

Returns:

Builder-style object to add options