uk.gov.gchq.gaffer.function.processor

Class Aggregator<R>

java.lang.Object

uk.gov.gchq.gaffer.function.processor.Processor<R,PassThroughFunctionContext<R,AggregateFunction>>

uk.gov.gchq.gaffer.function.processor.Aggregator<R>

Type Parameters:

R - The type of reference used by tuples.

All Implemented Interfaces:

Cloneable

public class Aggregator<R>
extends Processor<R,PassThroughFunctionContext<R,AggregateFunction>>

An Aggregator is a Processor that applies AggregateFunctions to a set of input Tuples, combining them to produce a single output tuple. Typically, a client will group tuples together in some way and use an Aggregator to combine them a group at a time, initialising the functions between each group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Aggregator.Builder<R> Implementation of the Builder pattern for Aggregator.

Constructor Summary

Constructors

Constructor and Description
Aggregator()

Method Summary

Modifier and Type	Method and Description
void	aggregate(Tuple<R> tuple) Aggregate an input Tuple using AggregateFunctions.
Aggregator<R>	clone() Create a deep copy of this Aggregator.
boolean	equals(Object o)
int	hashCode()
void	initFunctions() Initialise the AggregateFunctions used by this Aggregator.
void	state(Tuple<R> tuple) Write the current aggregated results into an output Tuple.
String	toString()

Methods inherited from class uk.gov.gchq.gaffer.function.processor.Processor

addFunction, addFunctions, getFunctions

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Aggregator

public Aggregator()

Method Detail

initFunctions

public void initFunctions()

Initialise the AggregateFunctions used by this Aggregator.

aggregate

public void aggregate(Tuple<R> tuple)

Aggregate an input Tuple using AggregateFunctions.

Parameters:

tuple - Tuple to be aggregated.

state

public void state(Tuple<R> tuple)

Write the current aggregated results into an output Tuple.

Parameters:

tuple - Output Tuple.

clone

public Aggregator<R> clone()

Create a deep copy of this Aggregator.

Specified by:

clone in class Processor<R,PassThroughFunctionContext<R,AggregateFunction>>

Returns:

Deep copy of this Aggregator.

equals

public boolean equals(Object o)

Overrides:

equals in class Processor<R,PassThroughFunctionContext<R,AggregateFunction>>

hashCode

public int hashCode()

Overrides:

hashCode in class Processor<R,PassThroughFunctionContext<R,AggregateFunction>>

toString

public String toString()

Overrides:

toString in class Processor<R,PassThroughFunctionContext<R,AggregateFunction>>