cascading.nested.core

Class NestedGetAllAggregateFunction<Node,Result>

java.lang.Object

cascading.operation.BaseOperation<Context>

cascading.nested.core.NestedBaseOperation<Node,Result,cascading.tuple.Tuple>

cascading.nested.core.NestedGetFunction<Node,Result>

cascading.nested.core.NestedGetAllAggregateFunction<Node,Result>

All Implemented Interfaces:

cascading.flow.planner.DeclaresResults, cascading.operation.Function<cascading.tuple.Tuple>, cascading.operation.Operation<cascading.tuple.Tuple>, cascading.util.Traceable, java.io.Serializable

public class NestedGetAllAggregateFunction<Node,Result>
extends NestedGetFunction<Node,Result>

Class NestedGetAllAggregateFunction is the base class for Function implementations that when given the root of a collection of container nodes, need to aggregate the values of a common child element.

For example, given an array of objects that represent a person, the function can calculate the average age of the people listed in the array if every object has the same property name for age.

The stringRootPointer value must point to a container node with one or more child elements or objects.

The pointerMap maps a child node or property found in the child object to a NestedAggregate implementation that implements the required aggregation algorithm.

If failOnMissingNode is true and the root pointer is empty or the field pointer returns a null value, the operation will fail.

See SimpleNestedAggregate for a convenient base implementation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class cascading.nested.core.NestedGetFunction

NestedGetFunction.Setter<Node>

Field Summary

Fields

Modifier and Type	Field and Description
protected NestedAggregate<Node,?>[]	nestedAggregates
protected heretical.pointer.path.NestedPointer<Node,Result>	rootPointer
protected cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>>	streamWrapper

Fields inherited from class cascading.nested.core.NestedGetFunction

failOnMissingNode, pointers

Fields inherited from class cascading.nested.core.NestedBaseOperation

nestedCoercibleType

Fields inherited from class cascading.operation.BaseOperation

fieldDeclaration, numArgs, trace

Fields inherited from interface cascading.operation.Operation

ANY

Constructor Summary

Constructors

Constructor and Description
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, boolean failOnMissingNode, java.util.Map<java.lang.String,NestedAggregate<Node,?>> pointerMap) Constructor NestedGetAllAggregateFunction creates a new NestedGetAllAggregateFunction instance.
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, boolean failOnMissingNode, java.lang.String[] stringPointers, NestedAggregate<Node,?>[] nestedAggregates)
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, cascading.tuple.Fields fieldDeclaration, boolean failOnMissingNode, java.lang.String[] stringPointers, NestedAggregate<Node,?>[] nestedAggregates)
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper, boolean failOnMissingNode, java.util.Map<java.lang.String,NestedAggregate<Node,?>> pointerMap)
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper, boolean failOnMissingNode, java.lang.String[] stringPointers, NestedAggregate<Node,?>[] nestedAggregates)
NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper, cascading.tuple.Fields fieldDeclaration, boolean failOnMissingNode, java.lang.String[] stringPointers, NestedAggregate<Node,?>[] nestedAggregates)

Method Summary

Modifier and Type	Method and Description
protected void	aggregateNode(cascading.util.Pair<NestedAggregate<Node,java.lang.Object>,java.lang.Object>[] pairs, Node node)
protected static <Node> NestedAggregate[]	asArrayOf(java.util.Collection<NestedAggregate<Node,?>> nestedAggregates)
protected static <Node> cascading.tuple.Fields	declared(java.util.Collection<NestedAggregate<Node,?>> nestedAggregates)
void	operate(cascading.flow.FlowProcess flowProcess, cascading.operation.FunctionCall<cascading.tuple.Tuple> functionCall)
void	prepare(cascading.flow.FlowProcess flowProcess, cascading.operation.OperationCall<cascading.tuple.Tuple> operationCall)
protected <Context> void	setInto(cascading.util.Pair<NestedAggregate<Node,Context>,Context>[] pairs, int i, Node result)
protected java.util.stream.Stream<Node>	stream(Result allAt) Applies the given stream wrapper function
protected void	verify(java.lang.String[] stringPointers)

Methods inherited from class cascading.nested.core.NestedGetFunction

asArray, asFields, extractResult, extractResult, setInto

Methods inherited from class cascading.nested.core.NestedBaseOperation

deepCopy, getCoercibleType, getLiteralNode, getNestedPointerCompiler, getRootNode, iterable, size

Methods inherited from class cascading.operation.BaseOperation

cleanup, equals, flush, getFieldDeclaration, getNumArgs, getTrace, hashCode, isSafe, printOperationInternal, toString, toStringInternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cascading.operation.Operation

cleanup, flush, getFieldDeclaration, getNumArgs, isSafe

Field Detail

rootPointer

protected final heretical.pointer.path.NestedPointer<Node,Result> rootPointer

streamWrapper

protected final cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper

nestedAggregates

protected final NestedAggregate<Node,?>[] nestedAggregates

Constructor Detail

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     boolean failOnMissingNode,
                                     java.util.Map<java.lang.String,NestedAggregate<Node,?>> pointerMap)

Constructor NestedGetAllAggregateFunction creates a new NestedGetAllAggregateFunction instance.

Parameters:

nestedCoercibleType - of type NestedCoercibleType

stringRootPointer - of type String

failOnMissingNode - of type boolean

pointerMap - of type Map

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper,
                                     boolean failOnMissingNode,
                                     java.util.Map<java.lang.String,NestedAggregate<Node,?>> pointerMap)

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     boolean failOnMissingNode,
                                     java.lang.String[] stringPointers,
                                     NestedAggregate<Node,?>[] nestedAggregates)

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     cascading.tuple.Fields fieldDeclaration,
                                     boolean failOnMissingNode,
                                     java.lang.String[] stringPointers,
                                     NestedAggregate<Node,?>[] nestedAggregates)

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper,
                                     boolean failOnMissingNode,
                                     java.lang.String[] stringPointers,
                                     NestedAggregate<Node,?>[] nestedAggregates)

NestedGetAllAggregateFunction

public NestedGetAllAggregateFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                                     java.lang.String stringRootPointer,
                                     cascading.operation.SerFunction<java.util.stream.Stream<Node>,java.util.stream.Stream<Node>> streamWrapper,
                                     cascading.tuple.Fields fieldDeclaration,
                                     boolean failOnMissingNode,
                                     java.lang.String[] stringPointers,
                                     NestedAggregate<Node,?>[] nestedAggregates)

Method Detail

declared

protected static <Node> cascading.tuple.Fields declared(java.util.Collection<NestedAggregate<Node,?>> nestedAggregates)

asArrayOf

protected static <Node> NestedAggregate[] asArrayOf(java.util.Collection<NestedAggregate<Node,?>> nestedAggregates)

verify

protected void verify(java.lang.String[] stringPointers)

Overrides:

verify in class NestedGetFunction<Node,Result>

prepare

public void prepare(cascading.flow.FlowProcess flowProcess,
                    cascading.operation.OperationCall<cascading.tuple.Tuple> operationCall)

Specified by:

prepare in interface cascading.operation.Operation<cascading.tuple.Tuple>

Overrides:

prepare in class NestedGetFunction<Node,Result>

operate

public void operate(cascading.flow.FlowProcess flowProcess,
                    cascading.operation.FunctionCall<cascading.tuple.Tuple> functionCall)

Specified by:

operate in interface cascading.operation.Function<cascading.tuple.Tuple>

Overrides:

operate in class NestedGetFunction<Node,Result>

stream

protected java.util.stream.Stream<Node> stream(Result allAt)

Applies the given stream wrapper function

Parameters:

allAt -

Returns:

aggregateNode

protected void aggregateNode(cascading.util.Pair<NestedAggregate<Node,java.lang.Object>,java.lang.Object>[] pairs,
                             Node node)

setInto

protected <Context> void setInto(cascading.util.Pair<NestedAggregate<Node,Context>,Context>[] pairs,
                                 int i,
                                 Node result)