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

Class TinkerGraph

java.lang.Object

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

org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph

All Implemented Interfaces:

AutoCloseable, Graph, Host

public class TinkerGraph
extends AbstractTinkerGraph

An in-memory (with optional persistence on calls to AbstractTinkerGraph.close()), reference implementation of the property graph interfaces provided by TinkerPop.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TinkerGraph.TinkerGraphFeatures
class	TinkerGraph.TinkerGraphGraphFeatures

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.tinkergraph.structure.AbstractTinkerGraph

AbstractTinkerGraph.DefaultIdManager, AbstractTinkerGraph.IdManager<T>, AbstractTinkerGraph.TinkerGraphEdgeFeatures, AbstractTinkerGraph.TinkerGraphVertexFeatures, 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 Map<Object,Edge>	edges
protected Map<Object,Vertex>	vertices

Fields inherited from class org.apache.tinkerpop.gremlin.tinkergraph.structure.AbstractTinkerGraph

allowNullPropertyValues, configuration, currentId, defaultVertexPropertyCardinality, edgeIdManager, edgeIndex, graphComputerView, graphFormat, graphLocation, GREMLIN_TINKERGRAPH_ALLOW_NULL_PROPERTY_VALUES, GREMLIN_TINKERGRAPH_DEFAULT_VERTEX_PROPERTY_CARDINALITY, GREMLIN_TINKERGRAPH_EDGE_ID_MANAGER, GREMLIN_TINKERGRAPH_GRAPH_FORMAT, GREMLIN_TINKERGRAPH_GRAPH_LOCATION, GREMLIN_TINKERGRAPH_SERVICE, GREMLIN_TINKERGRAPH_VERTEX_ID_MANAGER, GREMLIN_TINKERGRAPH_VERTEX_PROPERTY_ID_MANAGER, serviceRegistry, variables, vertexIdManager, vertexIndex, vertexPropertyIdManager

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

GRAPH

Method Summary

Modifier and Type	Method	Description
Edge	addEdge(TinkerVertex outVertex, TinkerVertex inVertex, String label, Object... keyValues)
protected void	addInEdge(TinkerVertex vertex, String label, Edge edge)
protected void	addOutEdge(TinkerVertex vertex, String label, Edge edge)
Vertex	addVertex(Object... keyValues)
void	clear()	Clear internal graph data
<E extends Element> void	createIndex(String key, Class<E> elementClass)	Create an index for said element class (Vertex or Edge) and said property key.
<E extends Element> void	dropIndex(String key, Class<E> elementClass)	Drop the index for the specified element class (Vertex or Edge) and key.
Edge	edge(Object edgeId)	Return Edge by id.
Iterator<Edge>	edges(Object... edgeIds)
Graph.Features	features()	Return TinkerGraph feature set.
int	getEdgesCount()	Graph-specific implementation for number of vertices.
TinkerServiceRegistry	getServiceRegistry()
int	getVerticesCount()	Graph-specific implementation for number of vertices.
boolean	hasEdge(Object id)
boolean	hasVertex(Object id)
static TinkerGraph	open()	Open a new TinkerGraph instance.
static TinkerGraph	open(org.apache.commons.configuration2.Configuration configuration)	Open a new TinkerGraph instance.
void	removeEdge(Object edgeId)
void	removeVertex(Object vertexId)
Transaction	tx()
Vertex	vertex(Object vertexId)	Return Vertex by id.
Iterator<Vertex>	vertices(Object... vertexIds)

Methods inherited from class org.apache.tinkerpop.gremlin.tinkergraph.structure.AbstractTinkerGraph

close, compute, compute, configuration, createTinkerEdge, createTinkerEdge, createTinkerVertex, createTinkerVertex, getIndexedKeys, instantiate, io, loadGraph, saveGraph, selectIdManager, toString, touch, touch, variables

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

Field Detail

vertices

protected Map<Object,Vertex> vertices

edges

protected Map<Object,Edge> edges

Method Detail

open

public static TinkerGraph open()

Open a new TinkerGraph instance.

Reference Implementation Help: If a Graph implementation does not require a Configuration (or perhaps has a default configuration) it can choose to implement a zero argument open() method. This is an optional constructor method for TinkerGraph. It is not enforced by the Gremlin Test Suite.

open

public static TinkerGraph open(org.apache.commons.configuration2.Configuration configuration)

Open a new TinkerGraph instance.

Reference Implementation Help: This method is the one use by the GraphFactory to instantiate Graph instances. This method must be overridden for the Structure Test Suite to pass. Implementers have latitude in terms of how exceptions are handled within this method. Such exceptions will be considered implementation specific by the test suite as all test generate graph instances by way of GraphFactory. As such, the exceptions get generalized behind that facade and since GraphFactory is the preferred method to opening graphs it will be consistent at that level.

Parameters:

configuration - the configuration for the instance

Returns:

a newly opened Graph

addVertex

public Vertex addVertex(Object... keyValues)

Description copied from class: AbstractTinkerGraph

Specified by:

addVertex in interface Graph

Specified by:

addVertex in class AbstractTinkerGraph

removeVertex

public void removeVertex(Object vertexId)

Description copied from class: AbstractTinkerGraph

Specified by:

removeVertex in class AbstractTinkerGraph

addEdge

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

Description copied from class: AbstractTinkerGraph

Specified by:

addEdge in class AbstractTinkerGraph

removeEdge

public void removeEdge(Object edgeId)

Description copied from class: AbstractTinkerGraph

Specified by:

removeEdge in class AbstractTinkerGraph

clear

public void clear()

Description copied from class: AbstractTinkerGraph

Clear internal graph data

Overrides:

clear in class AbstractTinkerGraph

tx

public Transaction tx()

Description copied from class: AbstractTinkerGraph

Specified by:

tx in interface Graph

Specified by:

tx in class AbstractTinkerGraph

getVerticesCount

public int getVerticesCount()

Description copied from class: AbstractTinkerGraph

Graph-specific implementation for number of vertices.

Specified by:

getVerticesCount in class AbstractTinkerGraph

Returns:

count of vertices in Graph.

hasVertex

public boolean hasVertex(Object id)

Description copied from class: AbstractTinkerGraph

Specified by:

hasVertex in class AbstractTinkerGraph

getEdgesCount

public int getEdgesCount()

Description copied from class: AbstractTinkerGraph

Graph-specific implementation for number of vertices.

Specified by:

getEdgesCount in class AbstractTinkerGraph

Returns:

count of vertices in Graph.

hasEdge

public boolean hasEdge(Object id)

Description copied from class: AbstractTinkerGraph

Specified by:

hasEdge in class AbstractTinkerGraph

getServiceRegistry

public TinkerServiceRegistry getServiceRegistry()

vertex

public Vertex vertex(Object vertexId)

Description copied from class: AbstractTinkerGraph

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

Specified by:

vertex in class AbstractTinkerGraph

Returns:

Vertex

vertices

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

Description copied from class: AbstractTinkerGraph

Specified by:

vertices in interface Graph

Specified by:

vertices in class AbstractTinkerGraph

edges

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

Description copied from class: AbstractTinkerGraph

Specified by:

edges in interface Graph

Specified by:

edges in class AbstractTinkerGraph

edge

public Edge edge(Object edgeId)

Description copied from class: AbstractTinkerGraph

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

Specified by:

edge in class AbstractTinkerGraph

Returns:

Edge

addOutEdge

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

Specified by:

addOutEdge in class AbstractTinkerGraph

addInEdge

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

Specified by:

addInEdge in class AbstractTinkerGraph

features

public Graph.Features features()

Return TinkerGraph feature set.

Reference Implementation Help: Implementers only need to implement features for which there are negative or instance configured features. By default, all Graph.Features return true.

createIndex

public <E extends Element> void createIndex(String key,
                                            Class<E> elementClass)

Create an index for said element class (Vertex or Edge) and said property key. Whenever an element has the specified key mutated, the index is updated. When the index is created, all existing elements are indexed to ensure that they are captured by the index.

Type Parameters:

E - The type of the element class

Parameters:

key - the property key to index

elementClass - the element class to index

dropIndex

public <E extends Element> void dropIndex(String key,
                                          Class<E> elementClass)

Drop the index for the specified element class (Vertex or Edge) and key.

Type Parameters:

E - The type of the element class

Parameters:

key - the property key to stop indexing

elementClass - the element class of the index to drop