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

Class IsStepPlaceholder<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.filter.FilterStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.filter.IsStepPlaceholder<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, IsStepContract<S>, GValueHolder<S,S>

public final class IsStepPlaceholder<S>
extends FilterStep<S>
implements GValueHolder<S,S>, IsStepContract<S>

See Also:

Serialized Form

Field Summary

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.filter.IsStepContract

CONCRETE_STEPS

Constructor Summary

Constructors

Constructor	Description
IsStepPlaceholder(Traversal.Admin traversal, P<S> predicate)

Method Summary

Modifier and Type	Method	Description
IsStep<S>	asConcreteStep()
IsStepPlaceholder<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
boolean	equals(Object o)
protected boolean	filter(Traverser.Admin<S> traverser)
Collection<GValue<?>>	getGValues()
P<S>	getPredicate()	Retrieves the step's predicate.
P<S>	getPredicateGValueSafe()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
int	hashCode()
boolean	isParameterized()
void	updateVariable(String name, Object value)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.filter.FilterStep

processNextStart

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, toString

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.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, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Constructor Detail

IsStepPlaceholder

public IsStepPlaceholder(Traversal.Admin traversal,
                         P<S> predicate)

Method Detail

filter

protected boolean filter(Traverser.Admin<S> traverser)

Specified by:

filter in class FilterStep<S>

getPredicate

public P<S> getPredicate()

Description copied from interface: IsStepContract

Retrieves the step's predicate.

Specified by:

getPredicate in interface IsStepContract<S>

Returns:

the predicate associated with the step

getPredicateGValueSafe

public P<S> getPredicateGValueSafe()

Specified by:

getPredicateGValueSafe in interface IsStepContract<S>

clone

public IsStepPlaceholder<S> 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,S>

Overrides:

clone in class AbstractStep<S,S>

Returns:

The cloned step

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractStep<S,S>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStep<S,S>

getRequirements

public Set<TraverserRequirement> getRequirements()

Description copied from interface: Step

Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.

Specified by:

getRequirements in interface IsStepContract<S>

Specified by:

getRequirements in interface Step<S,S>

Returns:

the set of requirements

asConcreteStep

public IsStep<S> asConcreteStep()

Specified by:

asConcreteStep in interface GValueHolder<S,S>

isParameterized

public boolean isParameterized()

Specified by:

isParameterized in interface GValueHolder<S,S>

updateVariable

public void updateVariable(String name,
                           Object value)

Specified by:

updateVariable in interface GValueHolder<S,S>

getGValues

public Collection<GValue<?>> getGValues()

Specified by:

getGValues in interface GValueHolder<S,S>