cascading.flow.planner.graph

Enum Extent

java.lang.Object

java.lang.Enum<Extent>

cascading.flow.planner.graph.Extent

All Implemented Interfaces:

FlowElement, Serializable, Comparable<Extent>

public enum Extent
extends Enum<Extent>
implements FlowElement

Enum Extent provides simple markers for the head and tail of an ElementGraph FlowElement graph.

Enum Constant Summary

Enum Constants

Enum Constant and Description
head
tail

Method Summary

Methods

Modifier and Type	Method and Description
ConfigDef	getConfigDef()
ConfigDef	getNodeConfigDef()
ConfigDef	getStepConfigDef()
boolean	hasConfigDef()
boolean	hasNodeConfigDef()
boolean	hasStepConfigDef()
boolean	isEquivalentTo(FlowElement element)
Scope	outgoingScopeFor(Set<Scope> scopes) Method outgoingScopeFor returns the Scope this FlowElement hands off to the next FlowElement.
Fields	resolveIncomingOperationArgumentFields(Scope incomingScope) Method resolveIncomingOperationArgumentFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing Operation arguments.
Fields	resolveIncomingOperationPassThroughFields(Scope incomingScope) Method resolveIncomingOperationPassThroughFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing the Pipe outgoing tuple.
String	toString()
static Extent	valueOf(String name) Returns the enum constant of this type with the specified name.
static Extent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

head

public static final Extent head

tail

public static final Extent tail

Method Detail

values

public static Extent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Extent c : Extent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Extent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

outgoingScopeFor

public Scope outgoingScopeFor(Set<Scope> scopes)

Description copied from interface: FlowElement

Method outgoingScopeFor returns the Scope this FlowElement hands off to the next FlowElement.

Specified by:

outgoingScopeFor in interface FlowElement

Parameters:

scopes - of type Set

Returns:

Scope

resolveIncomingOperationArgumentFields

public Fields resolveIncomingOperationArgumentFields(Scope incomingScope)

Description copied from interface: FlowElement

Method resolveIncomingOperationArgumentFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing Operation arguments.

Specified by:

resolveIncomingOperationArgumentFields in interface FlowElement

Parameters:

incomingScope - of type Scope

Returns:

Fields

resolveIncomingOperationPassThroughFields

public Fields resolveIncomingOperationPassThroughFields(Scope incomingScope)

Description copied from interface: FlowElement

Method resolveIncomingOperationPassThroughFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing the Pipe outgoing tuple.

Specified by:

resolveIncomingOperationPassThroughFields in interface FlowElement

Parameters:

incomingScope - of type Scope

Returns:

Fields

isEquivalentTo

public boolean isEquivalentTo(FlowElement element)

Specified by:

isEquivalentTo in interface FlowElement

getStepConfigDef

public ConfigDef getStepConfigDef()

Specified by:

getStepConfigDef in interface FlowElement

hasStepConfigDef

public boolean hasStepConfigDef()

Specified by:

hasStepConfigDef in interface FlowElement

getNodeConfigDef

public ConfigDef getNodeConfigDef()

Specified by:

getNodeConfigDef in interface FlowElement

hasNodeConfigDef

public boolean hasNodeConfigDef()

Specified by:

hasNodeConfigDef in interface FlowElement

getConfigDef

public ConfigDef getConfigDef()

Specified by:

getConfigDef in interface FlowElement

hasConfigDef

public boolean hasConfigDef()

Specified by:

hasConfigDef in interface FlowElement

toString

public String toString()

Overrides:

toString in class Enum<Extent>