org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphPropertyMapStep<K,E>

java.lang.Object

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

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphPropertyMapStep<K,E>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<Map<K,E>>>, org.apache.tinkerpop.gremlin.process.traversal.Step<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>, org.apache.tinkerpop.gremlin.process.traversal.step.ByModulating, org.apache.tinkerpop.gremlin.process.traversal.step.Configuring, org.apache.tinkerpop.gremlin.process.traversal.step.Parameterizing, org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent, MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

public class JanusGraphPropertyMapStep<K,E>
extends org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>
implements org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep

parameters, propertyKeys, propertyTraversal, returnType, tokens, traversalRing

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
JanusGraphPropertyMapStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E> originalStep, boolean prefetchAllPropertiesRequired, boolean prefetchingAllowed)

Method Summary

Modifier and Type	Method and Description
void	configure(Object... keyValues)
protected Map<K,E>	map(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element> traverser)
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	setBatchSize(int batchSize)
void	setMetrics(org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics metrics)
void	setPropertyTraversal(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<org.apache.tinkerpop.gremlin.structure.Element,? extends org.apache.tinkerpop.gremlin.structure.Property> propertyTraversal)
void	setUseMultiQuery(boolean useMultiQuery)

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep

addElementProperties, addIncludedOptions, applyTraversalRingToMap, clone, getElementId, getElementLabel, getIncludedTokens, getLocalChildren, getParameters, getPropertyKeys, getPropertyTraversal, getRequirements, getReturnType, getTraversalRing, getVertexPropertyKey, getVertexPropertyValue, hashCode, includeToken, modulateBy, setTraversal, toString

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep

processNextStart

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

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

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

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

addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

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

modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy

Constructor Detail

JanusGraphPropertyMapStep

public JanusGraphPropertyMapStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E> originalStep,
                                 boolean prefetchAllPropertiesRequired,
                                 boolean prefetchingAllowed)

Method Detail

configure

public void configure(Object... keyValues)

Specified by:

configure in interface org.apache.tinkerpop.gremlin.process.traversal.step.Configuring

Overrides:

configure in class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>

setPropertyTraversal

public void setPropertyTraversal(org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin<org.apache.tinkerpop.gremlin.structure.Element,? extends org.apache.tinkerpop.gremlin.structure.Property> propertyTraversal)

Overrides:

setPropertyTraversal in class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>

map

protected Map<K,E> map(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element> traverser)

Overrides:

map in class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep<K,E>

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

setUseMultiQuery

public void setUseMultiQuery(boolean useMultiQuery)

Specified by:

setUseMultiQuery in interface MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

setBatchSize

public void setBatchSize(int batchSize)

Specified by:

setBatchSize in interface MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

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<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

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<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

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<org.apache.tinkerpop.gremlin.structure.Element,Map<K,E>>

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.