cascading.nested.core

Class NestedGetFunction<Node,Result>

java.lang.Object

cascading.operation.BaseOperation<Context>

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

cascading.nested.core.NestedGetFunction<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

Direct Known Subclasses:

NestedGetAllAggregateFunction, NestedGetAllFunction

public class NestedGetFunction<Node,Result>
extends NestedBaseOperation<Node,Result,cascading.tuple.Tuple>
implements cascading.operation.Function<cascading.tuple.Tuple>

Class NestedGetFunction is the base class for Function implementations that want to simply retrieve values in nested object trees and return them as tuple fields.

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

If failOnMissingNode is true and the 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

Modifier and Type	Class and Description
protected static interface	NestedGetFunction.Setter<Node>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failOnMissingNode
protected heretical.pointer.path.NestedPointer<Node,Result>[]	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
NestedGetFunction(NestedCoercibleType<Node,Result> nestedCoercibleType, cascading.tuple.Fields fieldDeclaration, boolean failOnMissingNode, java.lang.String... stringPointers) Constructor NestedGetFunction creates a new NestedGetFunction instance.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String[]	asArray(java.util.Collection<java.lang.String> values)
protected static cascading.tuple.Fields	asFields(java.util.Set<cascading.tuple.Fields> fields)
protected void	extractResult(NestedGetFunction.Setter<Node> resultSetter, Node node)
protected void	extractResult(cascading.tuple.Tuple resultTuple, Node node)
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 void	setInto(cascading.tuple.Tuple resultTuple, int i, Node result)
protected void	verify(java.lang.String[] stringPointers)

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

pointers

protected final heretical.pointer.path.NestedPointer<Node,Result>[] pointers

failOnMissingNode

protected final boolean failOnMissingNode

Constructor Detail

NestedGetFunction

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

Constructor NestedGetFunction creates a new NestedGetFunction instance.

Parameters:

nestedCoercibleType - of NestedCoercibleType

fieldDeclaration - of Fields

failOnMissingNode - of boolean

stringPointers - of String...

Method Detail

asArray

protected static java.lang.String[] asArray(java.util.Collection<java.lang.String> values)

asFields

protected static cascading.tuple.Fields asFields(java.util.Set<cascading.tuple.Fields> fields)

verify

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

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 cascading.operation.BaseOperation<cascading.tuple.Tuple>

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>

extractResult

protected void extractResult(cascading.tuple.Tuple resultTuple,
                             Node node)

setInto

protected void setInto(cascading.tuple.Tuple resultTuple,
                       int i,
                       Node result)

extractResult

protected void extractResult(NestedGetFunction.Setter<Node> resultSetter,
                             Node node)