Package org.apache.tinkerpop.gremlin.process.traversal.step.map

Class GraphStepPlaceholder<S,E extends Element>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStepPlaceholder<S,E>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>, Configuring, GraphComputing, GValueHolder<S,E>, GraphStepContract<S,E>, Parameterizing

public class GraphStepPlaceholder<S,E extends Element>
extends AbstractStep<S,E>
implements GValueHolder<S,E>, GraphStepContract<S,E>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected GValue<?>[]	ids
protected Class<E>	returnClass
protected Parameters	withConfiguration

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

id, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Fields inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStepContract

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
GraphStepPlaceholder(Traversal.Admin traversal, Class<E> returnClass, boolean isStart, GValue<?>... ids)

Method Summary

Modifier and Type	Method	Description
GraphStep<S,E>	asConcreteStep()
void	clearIds()
GraphStepPlaceholder<S,E>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
void	close()
void	configure(Object... keyValues)	Accept a configuration to the Step.
boolean	equals(Object o)
Collection<GValue<?>>	getGValues()
Object[]	getIds()
GValue<?>[]	getIdsAsGValues()
Parameters	getParameters()	Gets the parameters on the step.
Class<E>	getReturnClass()
int	hashCode()
boolean	isParameterized()
boolean	isStartStep()
void	onGraphComputer()	The step will be executing on a GraphComputer.
protected Traverser.Admin<E>	processNextStart()
boolean	returnsEdge()
boolean	returnsVertex()
String	toString()
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addLabel, addStart, addStarts, clearLabels, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.GraphComputing

atMaster

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.GValueHolder

reduce

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Field Detail

withConfiguration

protected Parameters withConfiguration

returnClass

protected final Class<E extends Element> returnClass

ids

protected GValue<?>[] ids

Constructor Detail

GraphStepPlaceholder

public GraphStepPlaceholder(Traversal.Admin traversal,
                            Class<E> returnClass,
                            boolean isStart,
                            GValue<?>... ids)

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractStep<S,E extends Element>

close

public void close()

Specified by:

close in interface AutoCloseable

getReturnClass

public Class<E> getReturnClass()

Specified by:

getReturnClass in interface GraphStepContract<S,E extends Element>

isStartStep

public boolean isStartStep()

Specified by:

isStartStep in interface GraphStepContract<S,E extends Element>

returnsVertex

public boolean returnsVertex()

Specified by:

returnsVertex in interface GraphStepContract<S,E extends Element>

returnsEdge

public boolean returnsEdge()

Specified by:

returnsEdge in interface GraphStepContract<S,E extends Element>

getIds

public Object[] getIds()

Specified by:

getIds in interface GraphStepContract<S,E extends Element>

getIdsAsGValues

public GValue<?>[] getIdsAsGValues()

Specified by:

getIdsAsGValues in interface GraphStepContract<S,E extends Element>

clearIds

public void clearIds()

Specified by:

clearIds in interface GraphStepContract<S,E extends Element>

onGraphComputer

public void onGraphComputer()

Description copied from interface: GraphComputing

The step will be executing on a GraphComputer.

Specified by:

onGraphComputer in interface GraphComputing

processNextStart

protected Traverser.Admin<E> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,E extends Element>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,E extends Element>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,E extends Element>

asConcreteStep

public GraphStep<S,E> asConcreteStep()

Specified by:

asConcreteStep in interface GValueHolder<S,E extends Element>

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,E extends Element>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S,E extends Element>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,E extends Element>

clone

public GraphStepPlaceholder<S,E> clone()

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when Step.reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,E extends Element>

Overrides:

clone in class AbstractStep<S,E extends Element>

Returns:

The cloned step

configure

public void configure(Object... keyValues)

Description copied from interface: Configuring

Accept a configuration to the Step. Note that this interface extends Parameterizing and so there is an expectation that the Step implementation will have a Parameters instance that will house any values passed to this method. Storing these configurations in Parameters is not a requirement however, IF the configuration is an expected option for the step and can be stored on a member field that can be accessed on the step by more direct means (i.e. like a getter method).

Specified by:

configure in interface Configuring

getParameters

public Parameters getParameters()

Description copied from interface: Parameterizing

Gets the parameters on the step.

Specified by:

getParameters in interface Parameterizing