Package uk.gov.gchq.gaffer.data.element.function

Class ElementAggregator

java.lang.Object

uk.gov.gchq.koryphe.composite.Composite<C>

uk.gov.gchq.koryphe.binaryoperator.BinaryOperatorComposite<uk.gov.gchq.koryphe.tuple.Tuple<R>,uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<R,? extends Object>>

uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperatorComposite<String>

uk.gov.gchq.gaffer.data.element.function.ElementAggregator

All Implemented Interfaces:

BiFunction<uk.gov.gchq.koryphe.tuple.Tuple<String>,uk.gov.gchq.koryphe.tuple.Tuple<String>,uk.gov.gchq.koryphe.tuple.Tuple<String>>, BinaryOperator<uk.gov.gchq.koryphe.tuple.Tuple<String>>

public class ElementAggregator
extends uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperatorComposite<String>

An ElementAggregator is a BinaryOperator which aggregates two Element objects into a single element.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElementAggregator.Builder
static class	ElementAggregator.SelectedBuilder

Constructor Summary

Constructors

Constructor	Description
ElementAggregator()

Method Summary

Modifier and Type	Method	Description
Element	apply(Element state, Element element)	Aggregates the element.
Properties	apply(Properties state, Properties properties)
boolean	equals(Object obj)
List<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,?>>	getComponents()
int	hashCode()
void	lock()	Prevent any further changes being carried out.
String	toString()

Methods inherited from class uk.gov.gchq.koryphe.binaryoperator.BinaryOperatorComposite

apply

Methods inherited from class uk.gov.gchq.koryphe.composite.Composite

setComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.BiFunction

andThen

Constructor Detail

ElementAggregator

public ElementAggregator()

Method Detail

apply

public Element apply(Element state,
                     Element element)

Aggregates the element. Note - only the element properties are aggregated. Aggregation requires elements to have the same identifiers and group.

Parameters:

state - the other element to aggregate. This is normally the 'state' where the aggregated results will be set.

element - the element to aggregated

Returns:

Element - the aggregated element

apply

public Properties apply(Properties state,
                        Properties properties)

getComponents

public List<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,?>> getComponents()

Overrides:

getComponents in class uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperatorComposite<String>

lock

public void lock()

Prevent any further changes being carried out.

equals

public boolean equals(Object obj)

Overrides:

equals in class uk.gov.gchq.koryphe.composite.Composite<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,? extends Object>>

hashCode

public int hashCode()

Overrides:

hashCode in class uk.gov.gchq.koryphe.composite.Composite<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,? extends Object>>

toString

public String toString()

Overrides:

toString in class uk.gov.gchq.koryphe.composite.Composite<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,? extends Object>>