com.tinkerpop.gremlin.structure.strategy

Class StrategyGraph

java.lang.Object

com.tinkerpop.gremlin.structure.strategy.StrategyGraph

All Implemented Interfaces:

Graph, Graph.Iterators, StrategyWrapped, WrappedGraph<Graph>, java.lang.AutoCloseable

public class StrategyGraph
extends java.lang.Object
implements Graph, Graph.Iterators, StrategyWrapped, WrappedGraph<Graph>

A wrapper class for Graph instances that host and apply a GraphStrategy. The wrapper implements Graph itself and intercepts calls made to the hosted instance and then applies the strategy. Methods that return an extension of Element or a Property will be automatically wrapped in a StrategyWrapped implementation.

Author:

Stephen Mallette (http://stephen.genoprime.com), Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StrategyGraph.Exceptions

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.structure.Graph

Graph.Features, Graph.Helper, Graph.Hidden, Graph.Io, Graph.Iterators, Graph.OptIn, Graph.OptIns, Graph.OptOut, Graph.OptOuts, Graph.Variables

Field Summary

Fields inherited from interface com.tinkerpop.gremlin.structure.Graph

GRAPH

Constructor Summary

Constructors

Constructor and Description
StrategyGraph(Graph baseGraph)
StrategyGraph(Graph baseGraph, GraphStrategy strategy)

Method Summary

Modifier and Type	Method and Description
Vertex	addVertex(java.lang.Object... keyValues) Add a Vertex to the graph given an optional series of key/value pairs.
void	close()
<T> T	compose(java.util.function.Function<GraphStrategy,java.util.function.UnaryOperator<T>> f, T impl) Return a GraphStrategy function that takes the base function of the form denoted by T as an argument and returns back a function with T.
GraphComputer	compute(java.lang.Class... graphComputerClass) Create an OLAP GraphComputer to execute a vertex program over this graph.
org.apache.commons.configuration.Configuration	configuration() Get the Configuration associated with the construction of this graph.
GraphTraversal<Edge,Edge>	E(java.lang.Object... edgeIds) Starts a GraphTraversal over the edges in the graph.
java.util.Iterator<Edge>	edgeIterator(java.lang.Object... edgeIds) Get the Edge objects in this graph with the provided edge ids.
Graph.Features	features() Gets the Graph.Features exposed by the underlying Graph implementation.
Graph	getBaseGraph() Gets the underlying base Graph that is being hosted within this wrapper.
GraphStrategy	getStrategy() Gets the GraphStrategy for the Graph.
Graph.Iterators	iterators() Get the Graph.Iterators associated with this graph.
<T extends Traversal<S,S>,S> T	of(java.lang.Class<T> traversalClass) Constructs a new domain specific Traversal for this graph.
java.lang.String	toString()
Transaction	tx() Configure and control the transactions for those graphs that support this feature.
GraphTraversal<Vertex,Vertex>	V(java.lang.Object... vertexIds) Starts a GraphTraversal over the vertices in the graph.
Graph.Variables	variables() A collection of global Graph.Variables associated with the graph.
java.util.Iterator<Vertex>	vertexIterator(java.lang.Object... vertexIds) Get the Vertex objects in this graph with the provided vertex ids.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.gremlin.structure.Graph

addVertex, io, strategy

Constructor Detail

StrategyGraph

public StrategyGraph(Graph baseGraph)

StrategyGraph

public StrategyGraph(Graph baseGraph,
                     GraphStrategy strategy)

Method Detail

getBaseGraph

public Graph getBaseGraph()

Gets the underlying base Graph that is being hosted within this wrapper.

Specified by:

getBaseGraph in interface WrappedGraph<Graph>

getStrategy

public GraphStrategy getStrategy()

Gets the GraphStrategy for the Graph.

compose

public <T> T compose(java.util.function.Function<GraphStrategy,java.util.function.UnaryOperator<T>> f,
                     T impl)

Return a GraphStrategy function that takes the base function of the form denoted by T as an argument and returns back a function with T.

Parameters:

f - a function to execute if a GraphStrategy.

impl - the base implementation of an operation.

Returns:

a function that will be applied in the Gremlin Structure implementation

addVertex

public Vertex addVertex(java.lang.Object... keyValues)

Description copied from interface: Graph

Add a Vertex to the graph given an optional series of key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.

Specified by:

addVertex in interface Graph

Parameters:

keyValues - The key/value pairs to turn into vertex properties

Returns:

The newly created vertex

V

public GraphTraversal<Vertex,Vertex> V(java.lang.Object... vertexIds)

Description copied from interface: Graph

Starts a GraphTraversal over the vertices in the graph. If vertexIds are provided, then the traversal starts at those vertices, else all vertices in the graph.

Specified by:

V in interface Graph

Parameters:

vertexIds - the ids of the vertices to get (if none are provided, get all vertices)

Returns:

a graph traversal over the vertices of the graph

E

public GraphTraversal<Edge,Edge> E(java.lang.Object... edgeIds)

Description copied from interface: Graph

Starts a GraphTraversal over the edges in the graph. If edgeIds are provided, then the traversal starts at those edges, else all edges in the graph.

Specified by:

E in interface Graph

Parameters:

edgeIds - the ids of the edges to get (if none are provided, get all edges)

Returns:

a graph traversal over the edges of the graph

of

public <T extends Traversal<S,S>,S> T of(java.lang.Class<T> traversalClass)

Description copied from interface: Graph

Constructs a new domain specific Traversal for this graph.

Specified by:

of in interface Graph

Parameters:

traversalClass - the domain specific Traversal bound to this graph

compute

public GraphComputer compute(java.lang.Class... graphComputerClass)

Description copied from interface: Graph

Create an OLAP GraphComputer to execute a vertex program over this graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown. The provided arguments can be of either length 0 or 1. A graph can support multiple graph computers.

Specified by:

compute in interface Graph

Parameters:

graphComputerClass - The graph computer class to use (if no argument, then a default is selected by the graph)

Returns:

A graph computer for processing this graph

tx

public Transaction tx()

Description copied from interface: Graph

Configure and control the transactions for those graphs that support this feature.

Specified by:

tx in interface Graph

variables

public Graph.Variables variables()

Description copied from interface: Graph

A collection of global Graph.Variables associated with the graph. Variables are used for storing metadata about the graph.

Specified by:

variables in interface Graph

Returns:

The variables associated with this graph

configuration

public org.apache.commons.configuration.Configuration configuration()

Description copied from interface: Graph

Get the Configuration associated with the construction of this graph. Whatever configuration was passed to GraphFactory.open(org.apache.commons.configuration.Configuration) is what should be returned by this method.

Specified by:

configuration in interface Graph

Returns:

the configuration used during graph construction.

features

public Graph.Features features()

Description copied from interface: Graph

Gets the Graph.Features exposed by the underlying Graph implementation.

Specified by:

features in interface Graph

iterators

public Graph.Iterators iterators()

Description copied from interface: Graph

Get the Graph.Iterators associated with this graph.

Specified by:

iterators in interface Graph

Returns:

the graph iterators of this graph

vertexIterator

public java.util.Iterator<Vertex> vertexIterator(java.lang.Object... vertexIds)

Description copied from interface: Graph.Iterators

Get the Vertex objects in this graph with the provided vertex ids. If no ids are provided, get all vertices.

Specified by:

vertexIterator in interface Graph.Iterators

Parameters:

vertexIds - the ids of the vertices to get

Returns:

an Iterator of vertices that match the provided vertex ids

edgeIterator

public java.util.Iterator<Edge> edgeIterator(java.lang.Object... edgeIds)

Description copied from interface: Graph.Iterators

Get the Edge objects in this graph with the provided edge ids. If no ids are provided, get all edges.

Specified by:

edgeIterator in interface Graph.Iterators

Parameters:

edgeIds - the ids of the edges to get

Returns:

an Iterator of edges that match the provided edge ids

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object