org.apache.tinkerpop.gremlin.process.traversal

Interface TraversalEngine

All Superinterfaces:

Serializable

All Known Implementing Classes:

ComputerTraversalEngine, StandardTraversalEngine

public interface TraversalEngine
extends Serializable

A TraversalEngine is reponsible for executing a Traversal. There are two TraversalEngine.Types of TraversalEngines. TraversalEngine.Type.STANDARD is the OLTP, iterator-based model of graph traversal. TraversalEngine.Type.COMPUTER is the OLAP, message passing model of graph traversal. Every TraversalSource should be provided a TraversalEngine.Builder so it can construct an engine for each spawned Traversal.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TraversalEngine.Builder
static class	TraversalEngine.Type

Method Summary

Modifier and Type	Method and Description
Optional<GraphComputer>	getGraphComputer() If the traversal engine is of type TraversalEngine.Type.COMPUTER, then it should have the GraphComputer used for executing the traversal.
TraversalEngine.Type	getType() Get the type of the engine: TraversalEngine.Type.STANDARD or TraversalEngine.Type.COMPUTER.
default boolean	isComputer() Whether or not the type is TraversalEngine.Type.COMPUTER.
default boolean	isStandard() Whether or not the type is TraversalEngine.Type.STANDARD.

Method Detail

getType

TraversalEngine.Type getType()

Get the type of the engine: TraversalEngine.Type.STANDARD or TraversalEngine.Type.COMPUTER.

Returns:

the traversal engine type

getGraphComputer

Optional<GraphComputer> getGraphComputer()

If the traversal engine is of type TraversalEngine.Type.COMPUTER, then it should have the GraphComputer used for executing the traversal.

Returns:

an optional of containing the graph computer to be used for execution.

isStandard

default boolean isStandard()

Whether or not the type is TraversalEngine.Type.STANDARD.

Returns:

whether the engine type is standard (OLTP).

isComputer

default boolean isComputer()

Whether or not the type is TraversalEngine.Type.COMPUTER.

Returns:

whether the engine type is computer (OLAP).