org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphPropertiesStep<E>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.map.FlatMapStep<org.apache.tinkerpop.gremlin.structure.Element,E>

org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertiesStep<E>

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphPropertiesStep<E>

All Implemented Interfaces:

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

public class JanusGraphPropertiesStep<E>
extends org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertiesStep<E>
implements HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>, org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,E>

Author:

Matthias Broecheler (me@matthiasb.com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.janusgraph.graphdb.tinkerpop.optimize.step.HasStepFolder

HasStepFolder.OrderEntry

Field Summary

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

parameters, propertyKeys, returnType

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

Method Summary

Modifier and Type	Method and Description
void	addHasContainer(org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer hasContainer)
List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer>	addLocalHasContainersConvertingAndPContainers(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> localHasContainers)
List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer>	addLocalHasContainersSplittingAndPContainers(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, Iterable<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> has)
void	ensureAdditionalHasContainersCapacity(int additionalSize) Optional method which provides a hint to future has containers additions.
protected Iterator<E>	flatMap(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element> traverser) This initialisation method is called when an attempt to retrieve a vertex from the cached multiQuery results doesn't find an entry.
int	getHighLimit()
int	getLocalHighLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers)
int	getLocalLowLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers)
int	getLowLimit()
void	localOrderBy(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers, String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)
void	orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)
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	setLimit(int low, int high)
void	setLocalLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers, int low, int high)
void	setMetrics(org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics metrics)
void	setUseMultiQuery(boolean useMultiQuery)
String	toString()

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

close, configure, getParameters, getPropertyKeys, getRequirements, getReturnType, hashCode

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

closeIterator, processNextStart, reset

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

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.janusgraph.graphdb.tinkerpop.optimize.step.HasStepFolder

foldableHasContainerNoLimit, foldInHasContainer, foldInHasFilter, foldInIds, foldInOrder, foldInRange, isExistsStep, localFoldInHasContainer, splitAndP, validFoldInHasContainer, validJanusGraphHas, validJanusGraphHas, validJanusGraphOrder

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

Constructor Detail

JanusGraphPropertiesStep

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

Method Detail

setUseMultiQuery

public void setUseMultiQuery(boolean useMultiQuery)

Specified by:

setUseMultiQuery in interface MultiQueriable<org.apache.tinkerpop.gremlin.structure.Element,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,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,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,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.

flatMap

protected Iterator<E> flatMap(org.apache.tinkerpop.gremlin.process.traversal.Traverser.Admin<org.apache.tinkerpop.gremlin.structure.Element> traverser)

This initialisation method is called when an attempt to retrieve a vertex from the cached multiQuery results doesn't find an entry.

Overrides:

flatMap in class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertiesStep<E>

setBatchSize

public void setBatchSize(int batchSize)

Specified by:

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

ensureAdditionalHasContainersCapacity

public void ensureAdditionalHasContainersCapacity(int additionalSize)

Description copied from interface: HasStepFolder

Optional method which provides a hint to future has containers additions. The method will optionally resize the underlying array for future addition to ensure that it can hold additional elements. I.e. it will ensure that we can add `additionalSize` containers without any resizes.

Specified by:

ensureAdditionalHasContainersCapacity in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

addHasContainer

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

Specified by:

addHasContainer in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

addLocalHasContainersConvertingAndPContainers

public List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> addLocalHasContainersConvertingAndPContainers(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                                                                                                                                 List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> localHasContainers)

Specified by:

addLocalHasContainersConvertingAndPContainers in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

addLocalHasContainersSplittingAndPContainers

public List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> addLocalHasContainersSplittingAndPContainers(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                                                                                                                                Iterable<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> has)

Specified by:

addLocalHasContainersSplittingAndPContainers in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

orderBy

public void orderBy(String key,
                    org.apache.tinkerpop.gremlin.process.traversal.Order order)

Specified by:

orderBy in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

localOrderBy

public void localOrderBy(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                         List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers,
                         String key,
                         org.apache.tinkerpop.gremlin.process.traversal.Order order)

Specified by:

localOrderBy in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

setLimit

public void setLimit(int low,
                     int high)

Specified by:

setLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

setLocalLimit

public void setLocalLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                          List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers,
                          int low,
                          int high)

Specified by:

setLocalLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

getLowLimit

public int getLowLimit()

Specified by:

getLowLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

getLocalLowLimit

public int getLocalLowLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                            List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers)

Specified by:

getLocalLowLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

getHighLimit

public int getHighLimit()

Specified by:

getHighLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

getLocalHighLimit

public int getLocalHighLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent,
                             List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> hasContainers)

Specified by:

getLocalHighLimit in interface HasStepFolder<org.apache.tinkerpop.gremlin.structure.Element,E>

toString

public String toString()

Overrides:

toString in class org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertiesStep<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