org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphHasStep<S extends org.apache.tinkerpop.gremlin.structure.Element>

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.HasStep<S>

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphHasStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<S>>, org.apache.tinkerpop.gremlin.process.traversal.Step<S,S>, org.apache.tinkerpop.gremlin.process.traversal.step.Configuring, org.apache.tinkerpop.gremlin.process.traversal.step.HasContainerHolder, org.apache.tinkerpop.gremlin.process.traversal.step.Parameterizing, org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, MultiQueriable<S,S>

public class JanusGraphHasStep<S extends org.apache.tinkerpop.gremlin.structure.Element>
extends org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S>
implements org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, MultiQueriable<S,S>

This class extends the default TinkerPop's HasStep and adds vertices multi-query optimization to this step.

Before this step is evaluated it usually receives multiple future vertices which might be processed next with this step. This step stores all these vertices which might be needed later for evaluation and whenever this step receives the vertex for evaluation which wasn't preFetched previously it sends multi-query for a batch of vertices to fetch their properties and / or labels.

PreFetch logic in this step fetches either all properties or only selected properties (depending on how this step is configured) for all registered vertices, but no more than `txVertexCacheSize`. If there are more registered vertices than `txVertexCacheSize`, they will be left for later preFetch operation when these vertices become necessary.

This step optimizes only access to Vertex properties and skips optimization for any other Element.

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
JanusGraphHasStep(org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S> originalStep)
JanusGraphHasStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal, org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer... hasContainers)

Method Summary

Modifier and Type	Method and Description
void	addHasContainer(org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer hasContainer)
protected boolean	filter(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<S> traverser)
boolean	isPrefetchAllPropertiesRequired()
void	registerFirstNewLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex, int futureVertexTraverserLoop) Registers a vertex which will pass this step at some point in the future.
void	registerNextLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex, int futureVertexTraverserLoop) Registers a vertex which will pass this step at some point in the future.
void	registerSameLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex, int futureVertexTraverserLoop) Registers a vertex which will pass this step at some point in the future.
void	removeHasContainer(org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer hasContainer)
void	setBatchSize(int batchSize)
void	setMetrics(org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics metrics)
void	setPrefetchAllPropertiesRequired(boolean prefetchAllPropertiesRequired)
void	setTxVertexCacheSize(int txVertexCacheSize)
void	setUseMultiQuery(boolean useMultiQuery)
void	withPropertyPrefetch(String key)

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

clone, configure, getHasContainers, getParameters, getRequirements, hashCode, 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

addLabel, addStart, addStarts, equals, 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

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Constructor Detail

JanusGraphHasStep

public JanusGraphHasStep(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin traversal,
                         org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer... hasContainers)

JanusGraphHasStep

public JanusGraphHasStep(org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S> originalStep)

Method Detail

addHasContainer

public void addHasContainer(org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer hasContainer)

Specified by:

addHasContainer in interface org.apache.tinkerpop.gremlin.process.traversal.step.HasContainerHolder

Overrides:

addHasContainer in class org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S extends org.apache.tinkerpop.gremlin.structure.Element>

removeHasContainer

public void removeHasContainer(org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer hasContainer)

Specified by:

removeHasContainer in interface org.apache.tinkerpop.gremlin.process.traversal.step.HasContainerHolder

Overrides:

removeHasContainer in class org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S extends org.apache.tinkerpop.gremlin.structure.Element>

filter

protected boolean filter(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<S> traverser)

Overrides:

filter in class org.apache.tinkerpop.gremlin.process.traversal.step.filter.HasStep<S extends org.apache.tinkerpop.gremlin.structure.Element>

setUseMultiQuery

public void setUseMultiQuery(boolean useMultiQuery)

Specified by:

setUseMultiQuery in interface MultiQueriable<S extends org.apache.tinkerpop.gremlin.structure.Element,S extends org.apache.tinkerpop.gremlin.structure.Element>

setBatchSize

public void setBatchSize(int batchSize)

Specified by:

setBatchSize in interface MultiQueriable<S extends org.apache.tinkerpop.gremlin.structure.Element,S extends org.apache.tinkerpop.gremlin.structure.Element>

registerFirstNewLoopFutureVertexForPrefetching

public void registerFirstNewLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex,
                                                           int futureVertexTraverserLoop)

Description copied from interface: MultiQueriable

Registers a vertex which will pass this step at some point in the future. The vertex is typically known because a traverser at that vertex location has passed a previous step earlier. Using that information, a step can know in advance a set of vertices which it will have to handle in the future but on the next first loop of the traverser.

Specified by:

registerFirstNewLoopFutureVertexForPrefetching in interface MultiQueriable<S extends org.apache.tinkerpop.gremlin.structure.Element,S extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

futureVertex - The vertex which will reach the step in the future.

futureVertexTraverserLoop - In case traverser of the vertex supports loop then it should be provided via this parameter. Otherwise, `0` should be provided.

registerSameLoopFutureVertexForPrefetching

public void registerSameLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex,
                                                       int futureVertexTraverserLoop)

Description copied from interface: MultiQueriable

Registers a vertex which will pass this step at some point in the future. The vertex is typically known because a traverser at that vertex location has passed a previous step earlier. Using that information, a step can know in advance a set of vertices which it will have to handle in the future but on the same traverser loop.

Specified by:

registerSameLoopFutureVertexForPrefetching in interface MultiQueriable<S extends org.apache.tinkerpop.gremlin.structure.Element,S extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

futureVertex - The vertex which will reach the step in the future.

futureVertexTraverserLoop - In case traverser of the vertex supports loop then it should be provided via this parameter. Otherwise, `0` should be provided.

registerNextLoopFutureVertexForPrefetching

public void registerNextLoopFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex,
                                                       int futureVertexTraverserLoop)

Description copied from interface: MultiQueriable

Registers a vertex which will pass this step at some point in the future. The vertex is typically known because a traverser at that vertex location has passed a previous step earlier. Using that information, a step can know in advance a set of vertices which it will have to handle in the future but on the next traverser loop.

Specified by:

registerNextLoopFutureVertexForPrefetching in interface MultiQueriable<S extends org.apache.tinkerpop.gremlin.structure.Element,S extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

futureVertex - The vertex which will reach the step in the future.

futureVertexTraverserLoop - In case traverser of the vertex supports loop then it should be provided * via this parameter. Otherwise, `0` should be provided.

setMetrics

public void setMetrics(org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics metrics)

Specified by:

setMetrics in interface org.apache.tinkerpop.gremlin.process.traversal.step.Profiling

setTxVertexCacheSize

public void setTxVertexCacheSize(int txVertexCacheSize)

withPropertyPrefetch

public void withPropertyPrefetch(String key)

isPrefetchAllPropertiesRequired

public boolean isPrefetchAllPropertiesRequired()

setPrefetchAllPropertiesRequired

public void setPrefetchAllPropertiesRequired(boolean prefetchAllPropertiesRequired)