org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphMultiQueryStep

java.lang.Object

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

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphMultiQueryStep

All Implemented Interfaces:

Serializable, Cloneable, Iterator<org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element>>, org.apache.tinkerpop.gremlin.process.traversal.Step<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

public final class JanusGraphMultiQueryStep
extends org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

This step can be injected before a traversal parent, such as a union, and will cache the starts sent to the parent. The traversal parent will drip feed those starts into its child traversal. If the initial step of that child supports multiQuery then its faster if initialised with all the starts than just one at a time, so this step allows it to request the full set of starts from this step when initialising itself.

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

Constructor Summary

Constructors

Constructor and Description
JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal, boolean limitBatchSize)
JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal, boolean limitBatchSize, Integer relatedBarrierStepSize)
JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal, boolean limitBatchSize, org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep generatedBarrierStep)

Method Summary

Modifier and Type	Method and Description
void	attachFirstLoopClient(MultiQueriable mq)
void	attachNextLoopClient(MultiQueriable mq)
void	attachSameLoopClient(MultiQueriable mq)
JanusGraphMultiQueryStep	clone()
List<MultiQueriable>	getFirstLoopClientSteps()
org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep	getGeneratedBarrierStep()
List<MultiQueriable>	getNextLoopClientSteps()
Optional<Integer>	getRelatedBarrierStepSize()
List<MultiQueriable>	getSameLoopClientSteps()
boolean	isFirstLoopClientStepsEmpty()
boolean	isLimitBatchSize()
boolean	isNextLoopClientStepsEmpty()
boolean	isSameLoopClientStepsEmpty()
protected org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element>	processNextStart()
void	reset()

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

addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hashCode, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, 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

equals, getRequirements

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

JanusGraphMultiQueryStep

public JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal,
                                boolean limitBatchSize)

JanusGraphMultiQueryStep

public JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal,
                                boolean limitBatchSize,
                                org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep generatedBarrierStep)

JanusGraphMultiQueryStep

public JanusGraphMultiQueryStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal,
                                boolean limitBatchSize,
                                Integer relatedBarrierStepSize)

Method Detail

attachFirstLoopClient

public void attachFirstLoopClient(MultiQueriable mq)

attachSameLoopClient

public void attachSameLoopClient(MultiQueriable mq)

attachNextLoopClient

public void attachNextLoopClient(MultiQueriable mq)

processNextStart

protected org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element> processNextStart()
                                                                                                                                   throws NoSuchElementException

Specified by:

processNextStart in class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

Throws:

NoSuchElementException

clone

public JanusGraphMultiQueryStep clone()

Specified by:

clone in interface org.apache.tinkerpop.gremlin.process.traversal.Step<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

Overrides:

clone in class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

reset

public void reset()

Specified by:

reset in interface org.apache.tinkerpop.gremlin.process.traversal.Step<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

Overrides:

reset in class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<org.apache.tinkerpop.gremlin.structure.Element,org.apache.tinkerpop.gremlin.structure.Element>

isLimitBatchSize

public boolean isLimitBatchSize()

getFirstLoopClientSteps

public List<MultiQueriable> getFirstLoopClientSteps()

getSameLoopClientSteps

public List<MultiQueriable> getSameLoopClientSteps()

getNextLoopClientSteps

public List<MultiQueriable> getNextLoopClientSteps()

isFirstLoopClientStepsEmpty

public boolean isFirstLoopClientStepsEmpty()

isSameLoopClientStepsEmpty

public boolean isSameLoopClientStepsEmpty()

isNextLoopClientStepsEmpty

public boolean isNextLoopClientStepsEmpty()

getGeneratedBarrierStep

public org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep getGeneratedBarrierStep()

getRelatedBarrierStepSize

public Optional<Integer> getRelatedBarrierStepSize()