com.tinkerpop.gremlin.process

Interface TraversalStrategies

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

DefaultTraversalStrategies, EmptyTraversalStrategies

public interface TraversalStrategies
extends java.lang.Cloneable

Author:

Marko A. Rodriguez (http://markorodriguez.com), Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TraversalStrategies.GlobalCache

Method Summary

Modifier and Type	Method and Description
TraversalStrategies	addStrategies(TraversalStrategy... strategies) Add all the provided TraversalStrategy instances to the current collection.
void	applyStrategies(Traversal.Admin<?,?> traversal, TraversalEngine engine) Apply all the TraversalStrategy optimizers to the Traversal for the stated TraversalEngine.
TraversalStrategies	clone()
TraverserGenerator	getTraverserGenerator(Traversal.Admin<?,?> traversal) Get the TraverserGenerator to use to generate traversers in the Traversal.
TraversalStrategies	removeStrategies(java.lang.Class<? extends TraversalStrategy>... strategyClasses) Remove all the provided TraversalStrategy classes from the current collection.
void	setTraverserGeneratorFactory(TraverserGeneratorFactory traverserGeneratorFactory) Set the TraverserGeneratorFactory to use for determining which Traverser type to generate for the Traversal.
static void	sortStrategies(java.util.List<? extends TraversalStrategy> strategies) Sorts the list of provided strategies such that the TraversalStrategy.applyPost() and TraversalStrategy.applyPrior() dependencies are respected.
java.util.List<TraversalStrategy>	toList() Return all the TraversalStrategy singleton instances associated with this TraversalStrategies.

Method Detail

toList

java.util.List<TraversalStrategy> toList()

Return all the TraversalStrategy singleton instances associated with this TraversalStrategies.

applyStrategies

void applyStrategies(Traversal.Admin<?,?> traversal,
                     TraversalEngine engine)

Apply all the TraversalStrategy optimizers to the Traversal for the stated TraversalEngine. This method must ensure that the strategies are sorted prior to application.

Parameters:

traversal - the traversal to apply the strategies to

engine - the engine that the traversal is going to be executed on

addStrategies

TraversalStrategies addStrategies(TraversalStrategy... strategies)

Add all the provided TraversalStrategy instances to the current collection. When all the provided strategies have been added, the collection is resorted.

Parameters:

strategies - the traversal strategies to add

Returns:

the newly updated/sorted traversal strategies collection

removeStrategies

TraversalStrategies removeStrategies(java.lang.Class<? extends TraversalStrategy>... strategyClasses)

Remove all the provided TraversalStrategy classes from the current collection. When all the provided strategies have been removed, the collection is resorted.

Parameters:

strategyClasses - the traversal strategies to remove by their class

Returns:

the newly updated/sorted traversal strategies collection

clone

TraversalStrategies clone()
                   throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

getTraverserGenerator

TraverserGenerator getTraverserGenerator(Traversal.Admin<?,?> traversal)

Get the TraverserGenerator to use to generate traversers in the Traversal.

Parameters:

traversal - the traversal that will have traversers generated for it

setTraverserGeneratorFactory

void setTraverserGeneratorFactory(TraverserGeneratorFactory traverserGeneratorFactory)

Set the TraverserGeneratorFactory to use for determining which Traverser type to generate for the Traversal.

Parameters:

traverserGeneratorFactory - the factory to use

sortStrategies

static void sortStrategies(java.util.List<? extends TraversalStrategy> strategies)

Sorts the list of provided strategies such that the TraversalStrategy.applyPost() and TraversalStrategy.applyPrior() dependencies are respected.

Note, that the order may not be unique.

Parameters:

strategies - the traversal strategies to sort