cascading.nested.core

Class NestedGetAllFunction<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.NestedGetAllFunction<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 NestedGetAllFunction<Node,Result>
extends NestedGetFunction<Node,Result>

Class NestedGetAllFunction is the base class for Function implementations that want to simply retrieve a collection of values in nested object, and then transform each element node into a tuple with declared fields.

The stringRootPointer value must point to a container node with one or more elements. Each element will have values extracted and a new tuple will be emitted for each element.

For every field named in the fieldDeclaration Fields argument, there must be a corresponding stringPointer value.

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

If the fieldDeclaration Fields instance declares a type information, the nestedCoercibleType will be used to coerce any referenced child value to the expected field type.

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 heretical.pointer.path.NestedPointer<Node,Result>	rootPointer

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
NestedGetAllFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, java.lang.String stringRootPointer, cascading.tuple.Fields fieldDeclaration, boolean failOnMissingNode, java.lang.String... stringPointers) Constructor NestedGetAllFunction creates a new NestedGetFunction instance.

Method Summary

Modifier and Type	Method and Description
void	operate(cascading.flow.FlowProcess flowProcess, cascading.operation.FunctionCall<cascading.tuple.Tuple> functionCall)

Methods inherited from class cascading.nested.core.NestedGetFunction

asArray, asFields, extractResult, extractResult, prepare, setInto, verify

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 heretical.pointer.path.NestedPointer<Node,Result> rootPointer

Constructor Detail

NestedGetAllFunction

public NestedGetAllFunction(NestedCoercibleType<Node,Result> nestedCoercibleType,
                            java.lang.String stringRootPointer,
                            cascading.tuple.Fields fieldDeclaration,
                            boolean failOnMissingNode,
                            java.lang.String... stringPointers)

Constructor NestedGetAllFunction creates a new NestedGetFunction instance.

Parameters:

nestedCoercibleType - of NestedCoercibleType

stringRootPointer - of type String

fieldDeclaration - of type Fields

failOnMissingNode - of type boolean

stringPointers - of type String...

Method Detail

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>