org.janusgraph.graphdb.tinkerpop

Class JanusGraphBlueprintsGraph

java.lang.Object

org.janusgraph.graphdb.tinkerpop.JanusGraphBlueprintsGraph

All Implemented Interfaces:

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

Direct Known Subclasses:

StandardJanusGraph

public abstract class JanusGraphBlueprintsGraph
extends Object
implements JanusGraph

Blueprints specific implementation for JanusGraph. Handles thread-bound transactions.

Author:

Matthias Broecheler (me@matthiasb.com)

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 inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

GRAPH

Constructor Summary

Constructors

Constructor and Description
JanusGraphBlueprintsGraph()

Method Summary

Modifier and Type	Method and Description
EdgeLabel	addConnection(EdgeLabel edgeLabel, VertexLabel outVLabel, VertexLabel inVLabel) Add a constraint on which vertices the given edge label can connect.
EdgeLabel	addProperties(EdgeLabel edgeLabel, PropertyKey... keys) Add property constraints for a given edge label.
VertexLabel	addProperties(VertexLabel vertexLabel, PropertyKey... keys) Add property constraints for a given vertex label.
JanusGraphVertex	addVertex(Object... keyValues)
JanusGraphVertex	addVertex(String vertexLabel) Creates a new vertex in the graph with the vertex label named by the argument.
void	close() Closes the graph database.
FulgoraGraphComputer	compute()
<C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C	compute(Class<C> graphComputerClass)
org.apache.commons.configuration2.Configuration	configuration()
boolean	containsEdgeLabel(String name) Checks whether an edge label of the given name has been defined in the JanusGraph schema.
boolean	containsPropertyKey(String name) Checks whether a property key of the given name has been defined in the JanusGraph schema.
boolean	containsRelationType(String name) Checks whether a type with the specified name exists.
boolean	containsVertexLabel(String name) Whether a vertex label with the given name exists in the graph.
Iterator<org.apache.tinkerpop.gremlin.structure.Edge>	edges(Object... edgeIds)
JanusGraphTransaction	getCurrentThreadTx()
EdgeLabel	getEdgeLabel(String name) Returns the edge label with the given name.
EdgeLabel	getOrCreateEdgeLabel(String name) Returns the edge label with the given name.
PropertyKey	getOrCreatePropertyKey(String name) Returns the property key with the given name.
VertexLabel	getOrCreateVertexLabel(String name) Returns the vertex label with the given name.
PropertyKey	getPropertyKey(String name) Returns the property key with the given name.
RelationType	getRelationType(String name) Returns the type with the given name.
VertexLabel	getVertexLabel(String name) Returns the vertex label with the given name.
JanusGraphIndexQuery	indexQuery(String indexName, String query) Returns a JanusGraphIndexQuery to query for vertices or edges against the specified indexing backend using the given query string.
<I extends org.apache.tinkerpop.gremlin.structure.io.Io> I	io(org.apache.tinkerpop.gremlin.structure.io.Io.Builder<I> builder)
EdgeLabelMaker	makeEdgeLabel(String name) Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name.
PropertyKeyMaker	makePropertyKey(String name) Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name.
VertexLabelMaker	makeVertexLabel(String name) Returns a VertexLabelMaker to define a new vertex label with the given name.
MixedIndexCountQuery	mixedIndexCountQuery()
JanusGraphMultiVertexQuery	multiQuery(Collection<JanusGraphVertex> vertices)
JanusGraphMultiVertexQuery	multiQuery(JanusGraphVertex... vertices)
abstract JanusGraphTransaction	newThreadBoundTransaction()
JanusGraphQuery<? extends JanusGraphQuery>	query()
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.JanusGraph

buildTransaction, isClosed, isOpen, main, newTransaction, openManagement, version

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

features, traversal, traversal, tx

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

getHostingVertex

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

getOrCreatePropertyKey, getOrCreatePropertyKey

Constructor Detail

JanusGraphBlueprintsGraph

public JanusGraphBlueprintsGraph()

Method Detail

newThreadBoundTransaction

public abstract JanusGraphTransaction newThreadBoundTransaction()

getCurrentThreadTx

public JanusGraphTransaction getCurrentThreadTx()

close

public void close()

Description copied from interface: JanusGraph

Closes the graph database.

Closing the graph database causes a disconnect and possible closing of the underlying storage backend and a release of all occupied resources by this graph database. Closing a graph database requires that all open thread-independent transactions have been closed - otherwise they will be left abandoned.

Specified by:

close in interface AutoCloseable

Specified by:

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

Specified by:

close in interface JanusGraph

Specified by:

close in interface Transaction

tx

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

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

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

addVertex

public JanusGraphVertex addVertex(Object... keyValues)

Specified by:

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

Specified by:

addVertex in interface Transaction

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

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(String vertexLabel)

Description copied from interface: Transaction

Creates a new vertex in the graph with the vertex label named by the argument.

Specified by:

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

Specified by:

addVertex in interface Transaction

Parameters:

vertexLabel - the name of the vertex label to use

Returns:

a new vertex in the graph created in the context of this transaction

query

public JanusGraphQuery<? extends JanusGraphQuery> query()

Specified by:

query in interface Transaction

Returns:

See Also:

Transaction.query()

mixedIndexCountQuery

public MixedIndexCountQuery mixedIndexCountQuery()

Specified by:

mixedIndexCountQuery in interface Transaction

Returns:

a mixed index count query which leverages mixed index for counts

See Also:

StandardJanusGraphTx.mixedIndexCountQuery()

indexQuery

public JanusGraphIndexQuery indexQuery(String indexName,
                                       String query)

Description copied from interface: Transaction

Returns a JanusGraphIndexQuery to query for vertices or edges against the specified indexing backend using the given query string. The query string is analyzed and answered by the underlying storage backend.

Note, that using indexQuery may ignore modifications in the current transaction.

Specified by:

indexQuery in interface Transaction

Parameters:

indexName - Name of the index to query as configured

query - Query string

Returns:

JanusGraphIndexQuery object to query the index directly

multiQuery

public JanusGraphMultiVertexQuery multiQuery(JanusGraphVertex... vertices)

Specified by:

multiQuery in interface Transaction

Returns:

See Also:

Transaction.multiQuery(org.janusgraph.core.JanusGraphVertex...)

multiQuery

public JanusGraphMultiVertexQuery multiQuery(Collection<JanusGraphVertex> vertices)

Specified by:

multiQuery in interface Transaction

Returns:

See Also:

Transaction.multiQuery(java.util.Collection)

makePropertyKey

public PropertyKeyMaker makePropertyKey(String name)

Description copied from interface: SchemaManager

Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the key and associated consistency constraints.

The key constructed with this maker will be created in the context of this transaction.

Specified by:

makePropertyKey in interface SchemaManager

Returns:

a PropertyKeyMaker linked to this transaction.

See Also:

PropertyKeyMaker, PropertyKey

makeEdgeLabel

public EdgeLabelMaker makeEdgeLabel(String name)

Description copied from interface: SchemaManager

Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the label and associated consistency constraints.

The label constructed with this maker will be created in the context of this transaction.

Specified by:

makeEdgeLabel in interface SchemaManager

Returns:

a EdgeLabelMaker linked to this transaction.

See Also:

EdgeLabelMaker, EdgeLabel

makeVertexLabel

public VertexLabelMaker makeVertexLabel(String name)

Description copied from interface: SchemaManager

Returns a VertexLabelMaker to define a new vertex label with the given name. Note, that the name must be unique.

Specified by:

makeVertexLabel in interface SchemaManager

Returns:

addProperties

public VertexLabel addProperties(VertexLabel vertexLabel,
                                 PropertyKey... keys)

Description copied from interface: SchemaManager

Add property constraints for a given vertex label.

Specified by:

addProperties in interface SchemaManager

Parameters:

vertexLabel - to which the constraints applies.

keys - defines the properties which should be added to the VertexLabel as constraints.

Returns:

a VertexLabel edited which contains the added constraints.

addProperties

public EdgeLabel addProperties(EdgeLabel edgeLabel,
                               PropertyKey... keys)

Description copied from interface: SchemaManager

Add property constraints for a given edge label.

Specified by:

addProperties in interface SchemaManager

Parameters:

edgeLabel - to which the constraints applies.

keys - defines the properties which should be added to the EdgeLabel as constraints.

Returns:

a EdgeLabel edited which contains the added constraints.

addConnection

public EdgeLabel addConnection(EdgeLabel edgeLabel,
                               VertexLabel outVLabel,
                               VertexLabel inVLabel)

Description copied from interface: SchemaManager

Add a constraint on which vertices the given edge label can connect.

Specified by:

addConnection in interface SchemaManager

Parameters:

edgeLabel - to which the constraint applies.

outVLabel - specifies the outgoing vertex for this connection.

inVLabel - specifies the incoming vertex for this connection.

Returns:

a EdgeLabel edited which contains the added constraint.

containsPropertyKey

public boolean containsPropertyKey(String name)

Description copied from interface: SchemaInspector

Checks whether a property key of the given name has been defined in the JanusGraph schema.

Specified by:

containsPropertyKey in interface SchemaInspector

Parameters:

name - name of the property key

Returns:

true, if the property key exists, else false

getOrCreatePropertyKey

public PropertyKey getOrCreatePropertyKey(String name)

Description copied from interface: SchemaInspector

Returns the property key with the given name. If automatic type making is enabled, it will make the property key using the configured default type maker if a key with the given name does not exist.

Specified by:

getOrCreatePropertyKey in interface SchemaInspector

Parameters:

name - name of the property key to return

Returns:

the property key with the given name

See Also:

PropertyKey

getPropertyKey

public PropertyKey getPropertyKey(String name)

Description copied from interface: SchemaInspector

Returns the property key with the given name. If it does not exist, NULL is returned

Specified by:

getPropertyKey in interface SchemaInspector

Returns:

containsEdgeLabel

public boolean containsEdgeLabel(String name)

Description copied from interface: SchemaInspector

Checks whether an edge label of the given name has been defined in the JanusGraph schema.

Specified by:

containsEdgeLabel in interface SchemaInspector

Parameters:

name - name of the edge label

Returns:

true, if the edge label exists, else false

getOrCreateEdgeLabel

public EdgeLabel getOrCreateEdgeLabel(String name)

Description copied from interface: SchemaInspector

Returns the edge label with the given name. If automatic type making is enabled, it will make the edge label using the configured default type maker if a label with the given name does not exist.

Specified by:

getOrCreateEdgeLabel in interface SchemaInspector

Parameters:

name - name of the edge label to return

Returns:

the edge label with the given name

See Also:

EdgeLabel

getEdgeLabel

public EdgeLabel getEdgeLabel(String name)

Description copied from interface: SchemaInspector

Returns the edge label with the given name. If it does not exist, NULL is returned

Specified by:

getEdgeLabel in interface SchemaInspector

Returns:

containsRelationType

public boolean containsRelationType(String name)

Description copied from interface: SchemaInspector

Checks whether a type with the specified name exists.

Specified by:

containsRelationType in interface SchemaInspector

Parameters:

name - name of the type

Returns:

true, if a type with the given name exists, else false

getRelationType

public RelationType getRelationType(String name)

Description copied from interface: SchemaInspector

Returns the type with the given name. Note, that type names must be unique.

Specified by:

getRelationType in interface SchemaInspector

Parameters:

name - name of the type to return

Returns:

The type with the given name, or null if such does not exist

See Also:

RelationType

containsVertexLabel

public boolean containsVertexLabel(String name)

Description copied from interface: SchemaInspector

Whether a vertex label with the given name exists in the graph.

Specified by:

containsVertexLabel in interface SchemaInspector

Returns:

getVertexLabel

public VertexLabel getVertexLabel(String name)

Description copied from interface: SchemaInspector

Returns the vertex label with the given name. If such does not exist, NULL is returned.

Specified by:

getVertexLabel in interface SchemaInspector

Returns:

getOrCreateVertexLabel

public VertexLabel getOrCreateVertexLabel(String name)

Description copied from interface: SchemaInspector

Returns the vertex label with the given name. If a vertex label with this name does not exist, the label is automatically created through the registered DefaultSchemaMaker.

Attempting to automatically create a vertex label might cause an exception depending on the configuration.

Specified by:

getOrCreateVertexLabel in interface SchemaInspector

Returns: