org.apache.tinkerpop.gremlin.process.computer.util

Class ComputerGraph

java.lang.Object

org.apache.tinkerpop.gremlin.process.computer.util.ComputerGraph

All Implemented Interfaces:

AutoCloseable, Graph

public class ComputerGraph
extends Object
implements Graph

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComputerGraph.State

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

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

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

GRAPH

Constructor Summary

Constructors

Constructor and Description
ComputerGraph(Graph graph, Set<String> elementComputeKeys)

Method Summary

Modifier and Type	Method and Description
Vertex	addVertex(Object... keyValues) Add a Vertex to the graph given an optional series of key/value pairs.
void	close()
GraphComputer	compute()
<C extends GraphComputer> C	compute(Class<C> graphComputerClass) Declare the GraphComputer to use for OLAP operations on the graph.
Configuration	configuration() Get the org.apache.commons.configuration.Configuration associated with the construction of this graph.
Iterator<Edge>	edges(Object... edgeIds) Get the Edge objects in this graph with the provided edge ids.
static Vertex	of(Vertex vertex, Set<String> elementComputeKeys)
void	setState(ComputerGraph.State state)
Transaction	tx() Configure and control the transactions for those graphs that support this feature.
Graph.Variables	variables() A collection of global Graph.Variables associated with the graph.
Iterator<Vertex>	vertices(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, toString, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

addVertex, empty, features, io, traversal, traversal

Constructor Detail

ComputerGraph

public ComputerGraph(Graph graph,
                     Set<String> elementComputeKeys)

Method Detail

of

public static Vertex of(Vertex vertex,
                        Set<String> elementComputeKeys)

setState

public void setState(ComputerGraph.State state)

addVertex

public Vertex addVertex(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

compute

public <C extends GraphComputer> C compute(Class<C> graphComputerClass)
                                    throws IllegalArgumentException

Description copied from interface: Graph

Declare the GraphComputer to use for OLAP operations on the graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown.

Specified by:

compute in interface Graph

Parameters:

graphComputerClass - The graph computer class to use.

Returns:

A graph computer for processing this graph

Throws:

IllegalArgumentException - if the provided GraphComputer class is not supported.

compute

public GraphComputer compute()
                      throws IllegalArgumentException

Specified by:

compute in interface Graph

Throws:

IllegalArgumentException

vertices

public Iterator<Vertex> vertices(Object... vertexIds)

Description copied from interface: Graph

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

Specified by:

vertices in interface Graph

Parameters:

vertexIds - the ids of the vertices to get

Returns:

an Iterator of vertices that match the provided vertex ids

edges

public Iterator<Edge> edges(Object... edgeIds)

Description copied from interface: Graph

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

Specified by:

edges in interface Graph

Parameters:

edgeIds - the ids of the edges to get

Returns:

an Iterator of edges that match the provided edge ids

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 Configuration configuration()

Description copied from interface: Graph

Get the org.apache.commons.configuration.Configuration associated with the construction of this graph. Whatever configuration was passed to org.apache.tinkerpop.gremlin.structure.util.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.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception