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

Class TimeLimitStep<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.TimeLimitStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<S>>, Step<S,S>

public final class TimeLimitStep<S>
extends FilterStep<S>

Author:

Randall Barnhart (random pi), Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

See Also:

Serialized Form

Field Summary

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

id, label, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
TimeLimitStep(Traversal.Admin traversal, long timeLimit)

Method Summary

Modifier and Type	Method and Description
TimeLimitStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
protected boolean	filter(Traverser.Admin<S> traverser)
boolean	getTimedOut()
void	reset() Reset the state of the step such that it has no incoming starts.
String	toString()

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

addStart, addStarts, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, setId, setLabel, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getRequirements

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

TimeLimitStep

public TimeLimitStep(Traversal.Admin traversal,
                     long timeLimit)

Method Detail

filter

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

Specified by:

filter in class FilterStep<S>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

reset

public void reset()

Description copied from interface: Step

Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.

Specified by:

reset in interface Step<S,S>

Overrides:

reset in class AbstractStep<S,S>

getTimedOut

public boolean getTimedOut()

clone

public TimeLimitStep<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 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