com.tinkerpop.blueprints.impls.tg

Class TinkerGraph

java.lang.Object

com.tinkerpop.blueprints.impls.tg.TinkerGraph

All Implemented Interfaces:

Graph, IndexableGraph, KeyIndexableGraph, Serializable

public class TinkerGraph
extends Object
implements IndexableGraph, KeyIndexableGraph, Serializable

An in-memory, reference implementation of the property graph interfaces provided by Blueprints.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TinkerGraph.FileType
protected class	TinkerGraph.TinkerKeyIndex<T extends com.tinkerpop.blueprints.impls.tg.TinkerElement>

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	currentId
protected TinkerGraph.TinkerKeyIndex<com.tinkerpop.blueprints.impls.tg.TinkerEdge>	edgeKeyIndex
protected Map<String,Edge>	edges
protected Map<String,com.tinkerpop.blueprints.impls.tg.TinkerIndex>	indices
protected TinkerGraph.TinkerKeyIndex<com.tinkerpop.blueprints.impls.tg.TinkerVertex>	vertexKeyIndex
protected Map<String,Vertex>	vertices

Constructor Summary

Constructors

Constructor and Description
TinkerGraph()
TinkerGraph(org.apache.commons.configuration.Configuration configuration)
TinkerGraph(String directory)
TinkerGraph(String directory, TinkerGraph.FileType fileType)

Method Summary

Methods

Modifier and Type	Method and Description
Edge	addEdge(Object id, Vertex outVertex, Vertex inVertex, String label) Add an edge to the graph.
Vertex	addVertex(Object id) Create a new vertex, add it to the graph, and return the newly created vertex.
void	clear()
<T extends Element> Index<T>	createIndex(String indexName, Class<T> indexClass, Parameter... indexParameters) Generate an index with a particular name for a particular class.
<T extends Element> void	createKeyIndex(String key, Class<T> elementClass, Parameter... indexParameters) Create an automatic indexing structure for indexing provided key for element class.
void	dropIndex(String indexName) Remove an index associated with the graph.
<T extends Element> void	dropKeyIndex(String key, Class<T> elementClass) Remove an automatic indexing structure associated with indexing provided key for element class.
Edge	getEdge(Object id) Return the edge referenced by the provided object identifier.
Iterable<Edge>	getEdges() Return an iterable to all the edges in the graph.
Iterable<Edge>	getEdges(String key, Object value) Return an iterable to all the edges in the graph that have a particular key/value property.
Features	getFeatures() Get the particular features of the graph implementation.
<T extends Element> Index<T>	getIndex(String indexName, Class<T> indexClass) Get an index from the graph by its name and index class.
<T extends Element> Set<String>	getIndexedKeys(Class<T> elementClass) Return all the index keys associated with a particular element class.
Iterable<Index<? extends Element>>	getIndices() Get all the indices maintained by the graph.
Vertex	getVertex(Object id) Return the vertex referenced by the provided object identifier.
Iterable<Vertex>	getVertices() Return an iterable to all the vertices in the graph.
Iterable<Vertex>	getVertices(String key, Object value) Return an iterable to all the vertices in the graph that have a particular key/value property.
GraphQuery	query() Generate a query object that can be used to fine tune which edges/vertices are retrieved from the graph.
void	removeEdge(Edge edge) Remove the provided edge from the graph.
void	removeVertex(Vertex vertex) Remove the provided vertex from the graph.
void	shutdown() A shutdown function is required to properly close the graph.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

currentId

protected Long currentId

vertices

protected Map<String,Vertex> vertices

edges

protected Map<String,Edge> edges

indices

protected Map<String,com.tinkerpop.blueprints.impls.tg.TinkerIndex> indices

vertexKeyIndex

protected TinkerGraph.TinkerKeyIndex<com.tinkerpop.blueprints.impls.tg.TinkerVertex> vertexKeyIndex

edgeKeyIndex

protected TinkerGraph.TinkerKeyIndex<com.tinkerpop.blueprints.impls.tg.TinkerEdge> edgeKeyIndex

Constructor Detail

TinkerGraph

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

TinkerGraph

public TinkerGraph(String directory,
           TinkerGraph.FileType fileType)

TinkerGraph

public TinkerGraph(String directory)

TinkerGraph

public TinkerGraph()

Method Detail

getVertices

public Iterable<Vertex> getVertices(String key,
                           Object value)

Description copied from interface: Graph

Return an iterable to all the vertices in the graph that have a particular key/value property. If this is not possible for the implementation, then an UnsupportedOperationException can be thrown. The graph implementation should use indexing structures to make this efficient else a full vertex-filter scan is required.

Specified by:

getVertices in interface Graph

Parameters:

key - the key of vertex

value - the value of the vertex

Returns:

an iterable of vertices with provided key and value

getEdges

public Iterable<Edge> getEdges(String key,
                      Object value)

Description copied from interface: Graph

Return an iterable to all the edges in the graph that have a particular key/value property. If this is not possible for the implementation, then an UnsupportedOperationException can be thrown. The graph implementation should use indexing structures to make this efficient else a full edge-filter scan is required.

Specified by:

getEdges in interface Graph

Parameters:

key - the key of the edge

value - the value of the edge

Returns:

an iterable of edges with provided key and value

createKeyIndex

public <T extends Element> void createKeyIndex(String key,
                                      Class<T> elementClass,
                                      Parameter... indexParameters)

Description copied from interface: KeyIndexableGraph

Create an automatic indexing structure for indexing provided key for element class.

Specified by:

createKeyIndex in interface KeyIndexableGraph

Type Parameters:

T - the element class specification

Parameters:

key - the key to create the index for

elementClass - the element class that the index is for

indexParameters - a collection of parameters for the underlying index implementation

dropKeyIndex

public <T extends Element> void dropKeyIndex(String key,
                                    Class<T> elementClass)

Description copied from interface: KeyIndexableGraph

Remove an automatic indexing structure associated with indexing provided key for element class.

Specified by:

dropKeyIndex in interface KeyIndexableGraph

Type Parameters:

T - the element class specification

Parameters:

key - the key to drop the index for

elementClass - the element class that the index is for

getIndexedKeys

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

Description copied from interface: KeyIndexableGraph

Return all the index keys associated with a particular element class.

Specified by:

getIndexedKeys in interface KeyIndexableGraph

Type Parameters:

T - the element class specification

Parameters:

elementClass - the element class that the index is for

Returns:

the indexed keys as a Set

createIndex

public <T extends Element> Index<T> createIndex(String indexName,
                                       Class<T> indexClass,
                                       Parameter... indexParameters)

Description copied from interface: IndexableGraph

Generate an index with a particular name for a particular class.

Specified by:

createIndex in interface IndexableGraph

Type Parameters:

T - the element class that this index is indexing (can be base class)

Parameters:

indexName - the name of the manual index

indexClass - the element class that this index is indexing (can be base class)

indexParameters - a collection of parameters for the underlying index implementation

Returns:

the index created

getIndex

public <T extends Element> Index<T> getIndex(String indexName,
                                    Class<T> indexClass)

Description copied from interface: IndexableGraph

Get an index from the graph by its name and index class. An index is unique up to name.

Specified by:

getIndex in interface IndexableGraph

Type Parameters:

T - the class of the elements being indexed (can be base class)

Parameters:

indexName - the name of the index to retrieve

indexClass - the class of the elements being indexed (can be base class)

Returns:

the retrieved index

getIndices

public Iterable<Index<? extends Element>> getIndices()

Description copied from interface: IndexableGraph

Get all the indices maintained by the graph.

Specified by:

getIndices in interface IndexableGraph

Returns:

the indices associated with the graph

dropIndex

public void dropIndex(String indexName)

Description copied from interface: IndexableGraph

Remove an index associated with the graph.

Specified by:

dropIndex in interface IndexableGraph

Parameters:

indexName - the name of the index to drop

addVertex

public Vertex addVertex(Object id)

Description copied from interface: Graph

Create a new vertex, add it to the graph, and return the newly created vertex. The provided object identifier is a recommendation for the identifier to use. It is not required that the implementation use this identifier.

Specified by:

addVertex in interface Graph

Parameters:

id - the recommended object identifier

Returns:

the newly created vertex

getVertex

public Vertex getVertex(Object id)

Description copied from interface: Graph

Return the vertex referenced by the provided object identifier. If no vertex is referenced by that identifier, then return null.

Specified by:

getVertex in interface Graph

Parameters:

id - the identifier of the vertex to retrieved from the graph

Returns:

the vertex referenced by the provided identifier or null when no such vertex exists

getEdge

public Edge getEdge(Object id)

Description copied from interface: Graph

Return the edge referenced by the provided object identifier. If no edge is referenced by that identifier, then return null.

Specified by:

getEdge in interface Graph

Parameters:

id - the identifier of the edge to retrieved from the graph

Returns:

the edge referenced by the provided identifier or null when no such edge exists

getVertices

public Iterable<Vertex> getVertices()

Description copied from interface: Graph

Return an iterable to all the vertices in the graph. If this is not possible for the implementation, then an UnsupportedOperationException can be thrown.

Specified by:

getVertices in interface Graph

Returns:

an iterable reference to all vertices in the graph

getEdges

public Iterable<Edge> getEdges()

Description copied from interface: Graph

Return an iterable to all the edges in the graph. If this is not possible for the implementation, then an UnsupportedOperationException can be thrown.

Specified by:

getEdges in interface Graph

Returns:

an iterable reference to all edges in the graph

removeVertex

public void removeVertex(Vertex vertex)

Description copied from interface: Graph

Remove the provided vertex from the graph. Upon removing the vertex, all the edges by which the vertex is connected must be removed as well.

Specified by:

removeVertex in interface Graph

Parameters:

vertex - the vertex to remove from the graph

addEdge

public Edge addEdge(Object id,
           Vertex outVertex,
           Vertex inVertex,
           String label)

Description copied from interface: Graph

Add an edge to the graph. The added edges requires a recommended identifier, a tail vertex, an head vertex, and a label. Like adding a vertex, the provided object identifier may be ignored by the implementation.

Specified by:

addEdge in interface Graph

Parameters:

id - the recommended object identifier

outVertex - the vertex on the tail of the edge

inVertex - the vertex on the head of the edge

label - the label associated with the edge

Returns:

the newly created edge

removeEdge

public void removeEdge(Edge edge)

Description copied from interface: Graph

Remove the provided edge from the graph.

Specified by:

removeEdge in interface Graph

Parameters:

edge - the edge to remove from the graph

query

public GraphQuery query()

Description copied from interface: Graph

Generate a query object that can be used to fine tune which edges/vertices are retrieved from the graph.

Specified by:

query in interface Graph

Returns:

a graph query object with methods for constraining which data is pulled from the underlying graph

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

shutdown

public void shutdown()

Description copied from interface: Graph

A shutdown function is required to properly close the graph. This is important for implementations that utilize disk-based serializations.

Specified by:

shutdown in interface Graph

getFeatures

public Features getFeatures()

Description copied from interface: Graph

Get the particular features of the graph implementation. Not all graph implementations are identical nor perfectly implement the Blueprints API. The Features object returned contains meta-data about numerous potential divergences between implementations.

Specified by:

getFeatures in interface Graph

Returns:

the features of this particular Graph implementation