org.janusgraph.graphdb.tinkerpop.optimize.step

Class JanusGraphStep<S,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.GraphStep<S,E>

org.janusgraph.graphdb.tinkerpop.optimize.step.JanusGraphStep<S,E>

All Implemented Interfaces:

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

public class JanusGraphStep<S,E extends org.apache.tinkerpop.gremlin.structure.Element>
extends org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep<S,E>
implements HasStepFolder<S,E>, org.apache.tinkerpop.gremlin.process.traversal.step.Profiling, org.apache.tinkerpop.gremlin.process.traversal.step.HasContainerHolder

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.GraphStep

done, ids, isStart, iteratorSupplier, parameters, returnClass

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
JanusGraphStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep<S,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> unconvertedHasContainers)
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> hasContainers)
GraphCentricQuery	buildGlobalGraphCentricQuery()
void	ensureAdditionalHasContainersCapacity(int additionalSize) Optional method which provides a hint to future has containers additions.
List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer>	getHasContainers()
int	getHighLimit()
int	getLocalHighLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> containers)
int	getLocalLowLimit(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> containers)
int	getLowLimit()
List<HasStepFolder.OrderEntry>	getOrders()
int	hashCode()
void	localOrderBy(org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent parent, List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> containers, String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)
void	orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order)
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> containers, int low, int high)
void	setMetrics(org.apache.tinkerpop.gremlin.process.traversal.util.MutableMetrics metrics)
String	toString()

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

addIds, clearIds, close, configure, convertElementsToIds, getIds, getParameters, getReturnClass, isStartStep, isStartStep, onGraphComputer, processHasContainerIds, processNextStart, reset, returnsEdge, returnsVertex, setIteratorSupplier

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

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

removeHasContainer

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

atMaster, atMaster

Constructor Detail

JanusGraphStep

public JanusGraphStep(org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep<S,E> originalStep)

Method Detail

buildGlobalGraphCentricQuery

public GraphCentricQuery buildGlobalGraphCentricQuery()

toString

public String toString()

Overrides:

toString in class org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep<S,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<S,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> unconvertedHasContainers)

Specified by:

addLocalHasContainersConvertingAndPContainers in interface HasStepFolder<S,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> hasContainers)

Specified by:

addLocalHasContainersSplittingAndPContainers in interface HasStepFolder<S,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<S,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> containers,
                         String key,
                         org.apache.tinkerpop.gremlin.process.traversal.Order order)

Specified by:

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

setLimit

public void setLimit(int low,
                     int high)

Specified by:

setLimit in interface HasStepFolder<S,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> containers,
                          int low,
                          int high)

Specified by:

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

getLowLimit

public int getLowLimit()

Specified by:

getLowLimit in interface HasStepFolder<S,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> containers)

Specified by:

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

getHighLimit

public int getHighLimit()

Specified by:

getHighLimit in interface HasStepFolder<S,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> containers)

Specified by:

getLocalHighLimit in interface HasStepFolder<S,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

getHasContainers

public List<org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer> getHasContainers()

Specified by:

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

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

Specified by:

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

getOrders

public List<HasStepFolder.OrderEntry> getOrders()

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep<S,E extends org.apache.tinkerpop.gremlin.structure.Element>