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 aGraph
instance for the test suite to bind to. Test suites that use this must ensure that theTraversalSource
be generated from theirGraphProvider
in viaAnonymousTraversalSource.withRemote(RemoteConnection)
or similar overload. SeeRemoteGraphProvider
in the gremlin-server module for an example.- Author:
- Stephen Mallette (http://stephen.genoprime.com)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Vertex
addVertex(Object... keyValues)
void
close()
Closes the underlyingRemoteConnection
.GraphComputer
compute()
<C extends GraphComputer>
Ccompute(Class<C> graphComputerClass)
org.apache.commons.configuration2.Configuration
configuration()
Iterator<Edge>
edges(Object... edgeIds)
This method returns an emptyIterator
- it is not meant to be called directly.Graph.Features
features()
RemoteConnection
getConnection()
static RemoteGraph
open(String configFile)
static RemoteGraph
open(org.apache.commons.configuration2.Configuration conf)
Creates a newRemoteGraph
instance using the specified configuration, which allowsRemoteGraph
to be compliant withGraphFactory
.static RemoteGraph
open(RemoteConnection connection, org.apache.commons.configuration2.Configuration conf)
Creates a newRemoteGraph
instance.String
toString()
Transaction
tx()
Graph.Variables
variables()
Iterator<Vertex>
vertices(Object... vertexIds)
This method returns an emptyIterator
- it is not meant to be called directly.
-
-
-
Method Detail
-
open
public static RemoteGraph open(org.apache.commons.configuration2.Configuration conf)
Creates a newRemoteGraph
instance using the specified configuration, which allowsRemoteGraph
to be compliant withGraphFactory
. Expects key forRemoteConnection.GREMLIN_REMOTE_CONNECTION_CLASS
as well as any configuration required by the underlyingRemoteConnection
which will be instantiated. Note that theConfiguration
object is passed down without change to the creation of theRemoteConnection
instance.
-
open
public static RemoteGraph open(String configFile) throws Exception
- Throws:
Exception
-
open
public static RemoteGraph open(RemoteConnection connection, org.apache.commons.configuration2.Configuration conf)
Creates a newRemoteGraph
instance.RemoteGraph
will attempt to call theAutoCloseable.close()
method when theclose()
method is called on this class.- Parameters:
connection
- theRemoteConnection
instance to useRemoteConnection
-
getConnection
public RemoteConnection getConnection()
-
close
public void close() throws Exception
Closes the underlyingRemoteConnection
.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceGraph
- Throws:
Exception
-
compute
public <C extends GraphComputer> C compute(Class<C> graphComputerClass) throws IllegalArgumentException
- Specified by:
compute
in interfaceGraph
- Throws:
IllegalArgumentException
-
compute
public GraphComputer compute() throws IllegalArgumentException
- Specified by:
compute
in interfaceGraph
- Throws:
IllegalArgumentException
-
vertices
public Iterator<Vertex> vertices(Object... vertexIds)
This method returns an emptyIterator
- it is not meant to be called directly.
-
edges
public Iterator<Edge> edges(Object... edgeIds)
This method returns an emptyIterator
- it is not meant to be called directly.
-
tx
public Transaction tx()
-
variables
public Graph.Variables variables()
-
configuration
public org.apache.commons.configuration2.Configuration configuration()
- Specified by:
configuration
in interfaceGraph
-
features
public Graph.Features features()
-
-