org.janusgraph.graphdb.tinkerpop

Class JanusGraphBlueprintsTransaction

java.lang.Object

org.janusgraph.graphdb.tinkerpop.JanusGraphBlueprintsTransaction

All Implemented Interfaces:

AutoCloseable, org.apache.tinkerpop.gremlin.structure.Graph, org.apache.tinkerpop.gremlin.structure.util.Host, JanusGraphTransaction, SchemaInspector, SchemaManager, Transaction

Direct Known Subclasses:

StandardJanusGraphTx

public abstract class JanusGraphBlueprintsTransaction
extends Object
implements JanusGraphTransaction

Blueprints specific implementation of JanusGraphTransaction. Provides utility methods that wrap JanusGraph calls with Blueprints terminology.

Author:

Matthias Broecheler ([email protected])

Nested Class Summary

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

org.apache.tinkerpop.gremlin.structure.Graph.Exceptions, org.apache.tinkerpop.gremlin.structure.Graph.Features, org.apache.tinkerpop.gremlin.structure.Graph.Hidden, org.apache.tinkerpop.gremlin.structure.Graph.OptIn, org.apache.tinkerpop.gremlin.structure.Graph.OptIns, org.apache.tinkerpop.gremlin.structure.Graph.OptOut, org.apache.tinkerpop.gremlin.structure.Graph.OptOuts, org.apache.tinkerpop.gremlin.structure.Graph.Variables

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowCustomVertexIdType Whether this graph allows usage of custom vertex id of non-long-type

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

GRAPH

Constructor Summary

Constructors

Constructor and Description
JanusGraphBlueprintsTransaction()

Method Summary

Modifier and Type	Method and Description
JanusGraphVertex	addVertex(Object... keyValues) Creates a new vertex in the graph with the given vertex id.
void	close()
FulgoraGraphComputer	compute()
<C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C	compute(Class<C> graphComputerClass)
org.apache.commons.configuration2.Configuration	configuration()
Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(Object... edgeIds)
org.apache.tinkerpop.gremlin.structure.Graph.Features	features()
protected abstract JanusGraphBlueprintsGraph	getGraph() Returns the graph that this transaction is based on
<I extends org.apache.tinkerpop.gremlin.structure.io.Io> I	io(org.apache.tinkerpop.gremlin.structure.io.Io.Builder<I> builder)
String	toString()
org.apache.tinkerpop.gremlin.structure.Transaction	tx()
org.apache.tinkerpop.gremlin.structure.Graph.Variables	variables()
Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(Object... vertexIds)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janusgraph.core.JanusGraphTransaction

addVertex, commit, expireSchemaElement, getEdges, getVertex, getVertices, hasModifications, isClosed, isOpen, rollback

Methods inherited from interface org.janusgraph.core.Transaction

addVertex, indexQuery, mixedIndexAggQuery, multiQuery, multiQuery, query

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

getServiceRegistry, traversal, traversal, tx

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

getHostingVertex

Methods inherited from interface org.janusgraph.core.schema.SchemaManager

addConnection, addProperties, addProperties, makeEdgeLabel, makePropertyKey, makeVertexLabel

Methods inherited from interface org.janusgraph.core.schema.SchemaInspector

containsEdgeLabel, containsPropertyKey, containsRelationType, containsVertexLabel, getEdgeLabel, getOrCreateEdgeLabel, getOrCreatePropertyKey, getOrCreatePropertyKey, getOrCreatePropertyKey, getOrCreateVertexLabel, getPropertyKey, getRelationType, getVertexLabel

Field Detail

allowCustomVertexIdType

protected boolean allowCustomVertexIdType

Whether this graph allows usage of custom vertex id of non-long-type

Constructor Detail

JanusGraphBlueprintsTransaction

public JanusGraphBlueprintsTransaction()

Method Detail

getGraph

protected abstract JanusGraphBlueprintsGraph getGraph()

Returns the graph that this transaction is based on

Returns:

features

public org.apache.tinkerpop.gremlin.structure.Graph.Features features()

Specified by:

features in interface org.apache.tinkerpop.gremlin.structure.Graph

variables

public org.apache.tinkerpop.gremlin.structure.Graph.Variables variables()

Specified by:

variables in interface org.apache.tinkerpop.gremlin.structure.Graph

configuration

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

Specified by:

configuration in interface org.apache.tinkerpop.gremlin.structure.Graph

io

public <I extends org.apache.tinkerpop.gremlin.structure.io.Io> I io(org.apache.tinkerpop.gremlin.structure.io.Io.Builder<I> builder)

Specified by:

io in interface org.apache.tinkerpop.gremlin.structure.Graph

compute

public <C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C compute(Class<C> graphComputerClass)
                                                                                  throws IllegalArgumentException

Specified by:

compute in interface org.apache.tinkerpop.gremlin.structure.Graph

Throws:

IllegalArgumentException

compute

public FulgoraGraphComputer compute()
                             throws IllegalArgumentException

Specified by:

compute in interface org.apache.tinkerpop.gremlin.structure.Graph

Throws:

IllegalArgumentException

addVertex

public JanusGraphVertex addVertex(Object... keyValues)

Creates a new vertex in the graph with the given vertex id. Note, that an exception is thrown if the vertex id is not a valid JanusGraph vertex id or if a vertex with the given id already exists. Only accepts long ids - all others are ignored.

Custom id setting must be enabled via the configuration option GraphDatabaseConfiguration.ALLOW_SETTING_VERTEX_ID and valid JanusGraph vertex ids must be provided. Use IDManager.toVertexId(long) to construct a valid JanusGraph vertex id from a user id, where idManager can be obtained through StandardJanusGraph.getIDManager().

 long vertexId = ((StandardJanusGraph) graph).getIDManager().toVertexId(userVertexId);
 

Specified by:

addVertex in interface org.apache.tinkerpop.gremlin.structure.Graph

Specified by:

addVertex in interface Transaction

Parameters:

keyValues - key-value pairs of properties to characterize or attach to the vertex

Returns:

New vertex

vertices

public Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(Object... vertexIds)

Specified by:

vertices in interface org.apache.tinkerpop.gremlin.structure.Graph

edges

public Iterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(Object... edgeIds)

Specified by:

edges in interface org.apache.tinkerpop.gremlin.structure.Graph

toString

public String toString()

Overrides:

toString in class Object

tx

public org.apache.tinkerpop.gremlin.structure.Transaction tx()

Specified by:

tx in interface org.apache.tinkerpop.gremlin.structure.Graph

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.tinkerpop.gremlin.structure.Graph

Specified by:

close in interface Transaction