org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphVertexStep<E extends org.apache.tinkerpop.gremlin.structure.Element>

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.Vertex,E>

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

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphVertexStep<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.Vertex,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.Vertex,E>, MultiQueriable<org.apache.tinkerpop.gremlin.structure.Vertex,E>

public class JanusGraphVertexStep<E extends org.apache.tinkerpop.gremlin.structure.Element>
extends org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep<E>
implements HasStepFolder<org.apache.tinkerpop.gremlin.structure.Vertex,E>, org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, MultiQueriable<org.apache.tinkerpop.gremlin.structure.Vertex,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.VertexStep

parameters

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
JanusGraphVertexStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep<E> originalStep)

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.Vertex> traverser)
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)
<Q extends BaseVertexQuery> Q	makeQuery(Q query)
void	orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)
void	registerFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex) Registers a vertex which will pass this step at some point in the future.
void	setBatchPropertyPrefetching(boolean batchPropertyPrefetching)
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	setTxVertexCacheSize(int txVertexCacheSize)
void	setUseMultiQuery(boolean useMultiQuery)
String	toString()

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

close, configure, getDirection, getEdgeLabels, getParameters, getRequirements, getReturnClass, hashCode, returnsEdge, returnsVertex, reverseDirection

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

JanusGraphVertexStep

public JanusGraphVertexStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep<E> originalStep)

Method Detail

setUseMultiQuery

public void setUseMultiQuery(boolean useMultiQuery)

Specified by:

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

registerFutureVertexForPrefetching

public void registerFutureVertexForPrefetching(org.apache.tinkerpop.gremlin.structure.Vertex futureVertex)

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.

Specified by:

registerFutureVertexForPrefetching in interface MultiQueriable<org.apache.tinkerpop.gremlin.structure.Vertex,E extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

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

setBatchPropertyPrefetching

public void setBatchPropertyPrefetching(boolean batchPropertyPrefetching)

setTxVertexCacheSize

public void setTxVertexCacheSize(int txVertexCacheSize)

makeQuery

public <Q extends BaseVertexQuery> Q makeQuery(Q query)

flatMap

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

Overrides:

flatMap in class org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep<E extends org.apache.tinkerpop.gremlin.structure.Element>

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

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

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

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

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

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

setLimit

public void setLimit(int low,
                     int high)

Specified by:

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

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

getLowLimit

public int getLowLimit()

Specified by:

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

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

getHighLimit

public int getHighLimit()

Specified by:

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

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

toString

public String toString()

Overrides:

toString in class org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep<E extends org.apache.tinkerpop.gremlin.structure.Element>

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