org.apache.tinkerpop.gremlin.structure

Class RemoteGraph

java.lang.Object

org.apache.tinkerpop.gremlin.structure.RemoteGraph

All Implemented Interfaces:

AutoCloseable, Graph, Host

public class RemoteGraph
extends Object
implements Graph

RemoteGraph is only required for integrating with the test suite as there must be a Graph instance for the test suite to bind to. Test suites that use this must ensure that the TraversalSource be generated from their GraphProvider in via AnonymousTraversalSource.withRemote(RemoteConnection) or similar overload. See RemoteGraphProvider in the gremlin-server module for an example.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteGraph.RemoteFeatures
static class	RemoteGraph.RemoteGraphFeatures

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

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

Field Summary

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

GRAPH

Method Summary

Modifier and Type	Method and Description
Vertex	addVertex(Object... keyValues)
void	close() Closes the underlying RemoteConnection.
GraphComputer	compute()
<C extends GraphComputer> C	compute(Class<C> graphComputerClass)
org.apache.commons.configuration.Configuration	configuration()
Iterator<Edge>	edges(Object... edgeIds) This method returns an empty Iterator - it is not meant to be called directly.
Graph.Features	features()
RemoteConnection	getConnection()
static RemoteGraph	open(org.apache.commons.configuration.Configuration conf) Creates a new RemoteGraph instance using the specified configuration, which allows RemoteGraph to be compliant with GraphFactory.
static RemoteGraph	open(RemoteConnection connection, org.apache.commons.configuration.Configuration conf) Creates a new RemoteGraph instance.
static RemoteGraph	open(String configFile)
String	toString()
Transaction	tx()
Graph.Variables	variables()
Iterator<Vertex>	vertices(Object... vertexIds) This method returns an empty Iterator - it is not meant to be called directly.

Methods inherited from class java.lang.Object

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

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

addVertex, io, traversal, traversal

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Method Detail

open

public static RemoteGraph open(org.apache.commons.configuration.Configuration conf)

Creates a new RemoteGraph instance using the specified configuration, which allows RemoteGraph to be compliant with GraphFactory. Expects key for RemoteConnection.GREMLIN_REMOTE_CONNECTION_CLASS as well as any configuration required by the underlying RemoteConnection which will be instantiated. Note that the Configuration object is passed down without change to the creation of the RemoteConnection instance.

open

public static RemoteGraph open(String configFile)
                        throws Exception

Throws:

Exception

open

public static RemoteGraph open(RemoteConnection connection,
                               org.apache.commons.configuration.Configuration conf)

Creates a new RemoteGraph instance. RemoteGraph will attempt to call the AutoCloseable.close() method when the close() method is called on this class.

Parameters:

connection - the RemoteConnection instance to use RemoteConnection

getConnection

public RemoteConnection getConnection()

close

public void close()
           throws Exception

Closes the underlying RemoteConnection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Graph

Throws:

Exception

addVertex

public Vertex addVertex(Object... keyValues)

Specified by:

addVertex in interface Graph

compute

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

Specified by:

compute in interface Graph

Throws:

IllegalArgumentException

compute

public GraphComputer compute()
                      throws IllegalArgumentException

Specified by:

compute in interface Graph

Throws:

IllegalArgumentException

vertices

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

This method returns an empty Iterator - it is not meant to be called directly.

Specified by:

vertices in interface Graph

edges

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

This method returns an empty Iterator - it is not meant to be called directly.

Specified by:

edges in interface Graph

tx

public Transaction tx()

Specified by:

tx in interface Graph

variables

public Graph.Variables variables()

Specified by:

variables in interface Graph

configuration

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

Specified by:

configuration in interface Graph

features

public Graph.Features features()

Specified by:

features in interface Graph

toString

public String toString()

Overrides:

toString in class Object