Package org.apache.tinkerpop.gremlin.tinkergraph.structure

Class AbstractTinkerGraph

java.lang.Object

org.apache.tinkerpop.gremlin.tinkergraph.structure.AbstractTinkerGraph

All Implemented Interfaces:

AutoCloseable, Graph, Host

Direct Known Subclasses:

TinkerGraph, TinkerTransactionGraph

public abstract class AbstractTinkerGraph
extends Object
implements Graph

Base class for TinkerGraph and TinkerTransactionGraph. Contains common methods, variables and constants, but leaves the work with elements and indices to concrete implementations.

Author:

Valentyn Kahamlyk

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractTinkerGraph.DefaultIdManager	A default set of AbstractTinkerGraph.IdManager implementations for common identifier types.
static interface	AbstractTinkerGraph.IdManager<T>	TinkerGraph will use an implementation of this interface to generate identifiers when a user does not supply them and to handle identifier conversions when querying to provide better flexibility with respect to handling different data types that mean the same thing.
class	AbstractTinkerGraph.TinkerGraphEdgeFeatures
class	AbstractTinkerGraph.TinkerGraphVertexFeatures
class	AbstractTinkerGraph.TinkerGraphVertexPropertyFeatures

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

Modifier and Type	Field	Description
protected boolean	allowNullPropertyValues
protected org.apache.commons.configuration2.Configuration	configuration
protected AtomicLong	currentId
protected VertexProperty.Cardinality	defaultVertexPropertyCardinality
protected AbstractTinkerGraph.IdManager<Edge>	edgeIdManager
protected AbstractTinkerIndex<TinkerEdge>	edgeIndex
protected TinkerGraphComputerView	graphComputerView
protected String	graphFormat
protected String	graphLocation
static String	GREMLIN_TINKERGRAPH_ALLOW_NULL_PROPERTY_VALUES
static String	GREMLIN_TINKERGRAPH_DEFAULT_VERTEX_PROPERTY_CARDINALITY
static String	GREMLIN_TINKERGRAPH_EDGE_ID_MANAGER
static String	GREMLIN_TINKERGRAPH_GRAPH_FORMAT
static String	GREMLIN_TINKERGRAPH_GRAPH_LOCATION
static String	GREMLIN_TINKERGRAPH_SERVICE
static String	GREMLIN_TINKERGRAPH_VERTEX_ID_MANAGER
static String	GREMLIN_TINKERGRAPH_VERTEX_PROPERTY_ID_MANAGER
protected TinkerServiceRegistry	serviceRegistry
protected TinkerGraphVariables	variables
protected AbstractTinkerGraph.IdManager<Vertex>	vertexIdManager
protected AbstractTinkerIndex<TinkerVertex>	vertexIndex
protected AbstractTinkerGraph.IdManager<VertexProperty>	vertexPropertyIdManager

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

GRAPH

Constructor Summary

Constructors

Constructor	Description
AbstractTinkerGraph()

Method Summary

Modifier and Type	Method	Description
abstract Edge	addEdge(TinkerVertex outVertex, TinkerVertex inVertex, String label, Object... keyValues)
protected abstract void	addInEdge(TinkerVertex vertex, String label, Edge edge)
protected abstract void	addOutEdge(TinkerVertex vertex, String label, Edge edge)
abstract Vertex	addVertex(Object... keyValues)	Add a Vertex to the graph given an optional series of key/value pairs.
void	clear()	Clear internal graph data
void	close()	This method only has an effect if the GREMLIN_TINKERGRAPH_GRAPH_LOCATION is set, in which case the data in the graph is persisted to that location.
GraphComputer	compute()	Generate a GraphComputer using the default engine of the underlying graph system.
<C extends GraphComputer> C	compute(Class<C> graphComputerClass)	Declare the GraphComputer to use for OLAP operations on the graph.
org.apache.commons.configuration2.Configuration	configuration()	Get the Configuration associated with the construction of this graph.
protected TinkerEdge	createTinkerEdge(Object id, Vertex outVertex, String label, Vertex inVertex)
protected TinkerEdge	createTinkerEdge(Object id, Vertex outVertex, String label, Vertex inVertex, long currentVersion)
protected TinkerVertex	createTinkerVertex(Object id, String label, AbstractTinkerGraph graph)
protected TinkerVertex	createTinkerVertex(Object id, String label, AbstractTinkerGraph graph, long currentVersion)
abstract Edge	edge(Object edgeId)	Return Edge by id.
abstract Iterator<Edge>	edges(Object... edgeIds)	Get the Edge objects in this graph with the provided edge ids or Edge objects.
abstract int	getEdgesCount()	Graph-specific implementation for number of vertices.
<E extends Element> Set<String>	getIndexedKeys(Class<E> elementClass)	Return all the keys currently being index for said element class (Vertex or Edge).
abstract int	getVerticesCount()	Graph-specific implementation for number of vertices.
abstract boolean	hasEdge(Object id)
abstract boolean	hasVertex(Object id)
protected TinkerServiceRegistry.TinkerServiceFactory	instantiate(String className)
<I extends Io> I	io(Io.Builder<I> builder)	Construct a particular Io implementation for reading and writing the Graph and other data.
protected void	loadGraph()
abstract void	removeEdge(Object edgeId)
abstract void	removeVertex(Object vertexId)
protected void	saveGraph()
protected static <T extends Element> AbstractTinkerGraph.IdManager<T>	selectIdManager(org.apache.commons.configuration2.Configuration config, String configKey, Class<T> clazz)	Construct an AbstractTinkerGraph.IdManager from the TinkerGraph Configuration.
String	toString()
void	touch(TinkerEdge edge)	Mark Edge as changed in transaction.
void	touch(TinkerVertex vertex)	Mark Vertex as changed in transaction.
abstract 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.
abstract Vertex	vertex(Object vertexId)	Return Vertex by id.
abstract Iterator<Vertex>	vertices(Object... vertexIds)	Get the Vertex objects in this graph with the provided vertex ids or Vertex objects themselves.

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, features, getServiceRegistry, traversal, traversal, tx

Field Detail

GREMLIN_TINKERGRAPH_VERTEX_ID_MANAGER

public static final String GREMLIN_TINKERGRAPH_VERTEX_ID_MANAGER

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_EDGE_ID_MANAGER

public static final String GREMLIN_TINKERGRAPH_EDGE_ID_MANAGER

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_VERTEX_PROPERTY_ID_MANAGER

public static final String GREMLIN_TINKERGRAPH_VERTEX_PROPERTY_ID_MANAGER

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_DEFAULT_VERTEX_PROPERTY_CARDINALITY

public static final String GREMLIN_TINKERGRAPH_DEFAULT_VERTEX_PROPERTY_CARDINALITY

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_GRAPH_LOCATION

public static final String GREMLIN_TINKERGRAPH_GRAPH_LOCATION

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_GRAPH_FORMAT

public static final String GREMLIN_TINKERGRAPH_GRAPH_FORMAT

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_ALLOW_NULL_PROPERTY_VALUES

public static final String GREMLIN_TINKERGRAPH_ALLOW_NULL_PROPERTY_VALUES

See Also:

Constant Field Values

GREMLIN_TINKERGRAPH_SERVICE

public static final String GREMLIN_TINKERGRAPH_SERVICE

See Also:

Constant Field Values

currentId

protected AtomicLong currentId

variables

protected TinkerGraphVariables variables

graphComputerView

protected TinkerGraphComputerView graphComputerView

vertexIndex

protected AbstractTinkerIndex<TinkerVertex> vertexIndex

edgeIndex

protected AbstractTinkerIndex<TinkerEdge> edgeIndex

vertexIdManager

protected AbstractTinkerGraph.IdManager<Vertex> vertexIdManager

edgeIdManager

protected AbstractTinkerGraph.IdManager<Edge> edgeIdManager

vertexPropertyIdManager

protected AbstractTinkerGraph.IdManager<VertexProperty> vertexPropertyIdManager

defaultVertexPropertyCardinality

protected VertexProperty.Cardinality defaultVertexPropertyCardinality

allowNullPropertyValues

protected boolean allowNullPropertyValues

serviceRegistry

protected TinkerServiceRegistry serviceRegistry

configuration

protected org.apache.commons.configuration2.Configuration configuration

graphLocation

protected String graphLocation

graphFormat

protected String graphFormat

Constructor Detail

AbstractTinkerGraph

public AbstractTinkerGraph()

Method Detail

addVertex

public abstract Vertex addVertex(Object... keyValues)

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

removeVertex

public abstract void removeVertex(Object vertexId)

addEdge

public abstract Edge addEdge(TinkerVertex outVertex,
                             TinkerVertex inVertex,
                             String label,
                             Object... keyValues)

removeEdge

public abstract void removeEdge(Object edgeId)

touch

public void touch(TinkerVertex vertex)

Mark Vertex as changed in transaction. If the graph does not support transactions, then does nothing.

Parameters:

vertex -

touch

public void touch(TinkerEdge edge)

Mark Edge as changed in transaction. If the graph does not support transactions, then does nothing.

Parameters:

edge -

vertex

public abstract Vertex vertex(Object vertexId)

Return Vertex by id. Does not create an iterator, so is the preferred method when only 1 element needs to be returned.

Parameters:

vertexId -

Returns:

Vertex

vertices

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

Get the Vertex objects in this graph with the provided vertex ids or Vertex objects themselves. If no ids are provided, get all vertices. Note that a vertex identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here.

If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with:

• g.vertices(v)
• g.vertices(v.id())
• g.vertices(1)
• g.vertices(1L)
• g.vertices(1.0d)
• g.vertices(1.0f)
• g.vertices("1")

If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with:

• g.vertices(v)
• g.vertices(v.id())
• g.vertices(v.id().toString())

If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with:

• g.vertices(v)
• g.vertices(v.id())

If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with:

• g.vertices(v)
• g.vertices(v.id().toString())
• g.vertices("id")

If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with:

• g.vertices(v)
• g.vertices(v.id().toString())
• g.vertices("id")

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

edge

public abstract Edge edge(Object edgeId)

Return Edge by id. Does not create an iterator, so is the preferred method when only 1 element needs to be returned.

Parameters:

edgeId -

Returns:

Edge

edges

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

Get the Edge objects in this graph with the provided edge ids or Edge objects. If no ids are provided, get all edges. Note that an edge identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here.

If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with:

• g.edges(e)
• g.edges(e.id())
• g.edges(1)
• g.edges(1L)
• g.edges(1.0d)
• g.edges(1.0f)
• g.edges("1")

If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with:

• g.edges(e)
• g.edges(e.id())
• g.edges(e.id().toString())

If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with:

• g.edges(e)
• g.edges(e.id())

If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with:

• g.edges(e)
• g.edges(e.id().toString())
• g.edges("id")

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 abstract Transaction tx()

Configure and control the transactions for those graphs that support this feature.

Specified by:

tx in interface Graph

getVerticesCount

public abstract int getVerticesCount()

Graph-specific implementation for number of vertices.

Returns:

count of vertices in Graph.

hasVertex

public abstract boolean hasVertex(Object id)

getEdgesCount

public abstract int getEdgesCount()

Graph-specific implementation for number of vertices.

Returns:

count of vertices in Graph.

hasEdge

public abstract boolean hasEdge(Object id)

loadGraph

protected void loadGraph()

saveGraph

protected void saveGraph()

io

public <I extends Io> I io(Io.Builder<I> builder)

Description copied from interface: Graph

Construct a particular Io implementation for reading and writing the Graph and other data. End-users will "select" the Io implementation that they want to use by supplying the Io.Builder that constructs it. In this way, Graph vendors can supply their IoRegistry to that builder thus allowing for custom serializers to be auto-configured into the Io instance. Registering custom serializers is particularly useful for those graphs that have complex types for Element identifiers.

For those graphs that do not need to register any custom serializers, the default implementation should suffice. If the default is overridden, take care to register the current graph via the Io.Builder.graph(Graph) method.

Specified by:

io in interface Graph

compute

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

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

compute

public GraphComputer compute()

Description copied from interface: Graph

Generate a GraphComputer using the default engine of the underlying graph system. This is a shorthand method for the more involved method that uses Graph.compute(Class).

Specified by:

compute in interface Graph

Returns:

A default graph computer

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

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Clear internal graph data

close

public void close()

This method only has an effect if the GREMLIN_TINKERGRAPH_GRAPH_LOCATION is set, in which case the data in the graph is persisted to that location. This method may be called multiple times and does not release resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Graph

configuration

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

Description copied from interface: Graph

Get the Configuration associated with the construction of this graph. Whatever configuration was passed to GraphFactory.open(Configuration) is what should be returned by this method.

Specified by:

configuration in interface Graph

Returns:

the configuration used during graph construction.

addOutEdge

protected abstract void addOutEdge(TinkerVertex vertex,
                                   String label,
                                   Edge edge)

addInEdge

protected abstract void addInEdge(TinkerVertex vertex,
                                  String label,
                                  Edge edge)

createTinkerVertex

protected TinkerVertex createTinkerVertex(Object id,
                                          String label,
                                          AbstractTinkerGraph graph)

createTinkerVertex

protected TinkerVertex createTinkerVertex(Object id,
                                          String label,
                                          AbstractTinkerGraph graph,
                                          long currentVersion)

createTinkerEdge

protected TinkerEdge createTinkerEdge(Object id,
                                      Vertex outVertex,
                                      String label,
                                      Vertex inVertex)

createTinkerEdge

protected TinkerEdge createTinkerEdge(Object id,
                                      Vertex outVertex,
                                      String label,
                                      Vertex inVertex,
                                      long currentVersion)

getIndexedKeys

public <E extends Element> Set<String> getIndexedKeys(Class<E> elementClass)

Return all the keys currently being index for said element class (Vertex or Edge).

Type Parameters:

E - The type of the element class

Parameters:

elementClass - the element class to get the indexed keys for

Returns:

the set of keys currently being indexed

selectIdManager

protected static <T extends Element> AbstractTinkerGraph.IdManager<T> selectIdManager(org.apache.commons.configuration2.Configuration config,
                                                                                      String configKey,
                                                                                      Class<T> clazz)

Construct an AbstractTinkerGraph.IdManager from the TinkerGraph Configuration.

instantiate

protected TinkerServiceRegistry.TinkerServiceFactory instantiate(String className)