com.tinkerpop.blueprints.util.wrappers.id

Class IdGraph<T extends KeyIndexableGraph>

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.id.IdGraph<T>

All Implemented Interfaces:

Graph, IndexableGraph, KeyIndexableGraph, TransactionalGraph, WrapperGraph<T>

public class IdGraph<T extends KeyIndexableGraph>
extends Object
implements KeyIndexableGraph, WrapperGraph<T>, IndexableGraph, TransactionalGraph

A Graph implementation which wraps another Graph implementation, enabling custom element IDs even for those graphs which don't otherwise support them. The base Graph must be an instance of KeyIndexableGraph. It *may* be an instance of IndexableGraph, in which case its indices will be wrapped appropriately. It *may* be an instance of TransactionalGraph, in which case transaction operations will be passed through. For those graphs which support vertex indices but not edge indices (or vice versa), you may configure IdGraph to use custom IDs only for vertices or only for edges.

Author:

Joshua Shinavier (http://fortytwo.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdGraph.IdFactory A factory for IDs of newly-created vertices and edges (where an ID is not otherwise specified).

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

TransactionalGraph.Conclusion

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
IdGraph(T baseGraph) Adds custom ID functionality to the given graph, supporting both custom vertex IDs and custom edge IDs.
IdGraph(T baseGraph, boolean supportVertexIds, boolean supportEdgeIds) Adds custom ID functionality to the given graph, supporting either custom vertex IDs, custom edge IDs, or both.

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	commit() Stop the current transaction and successfully apply mutations to the graph.
<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.
void	enforceUniqueIds(boolean enforceUniqueIds)
T	getBaseGraph() Get the graph this wrapper delegates to.
Edge	getEdge(Object id) Return the edge referenced by the provided object identifier.
IdGraph.IdFactory	getEdgeIdFactory() return the factory for new edge IDs.
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.
boolean	getSupportEdgeIds()
boolean	getSupportVertexIds()
Vertex	getVertex(Object id) Return the vertex referenced by the provided object identifier.
IdGraph.IdFactory	getVertexIdFactory()
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	rollback() Stop the current transaction and drop any mutations applied since the last transaction.
void	setEdgeIdFactory(IdGraph.IdFactory idFactory)
void	setVertexIdFactory(IdGraph.IdFactory idFactory)
void	shutdown() A shutdown function is required to properly close the graph.
void	stopTransaction(TransactionalGraph.Conclusion conclusion) Stop the current transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

IdGraph

public IdGraph(T baseGraph)

Adds custom ID functionality to the given graph, supporting both custom vertex IDs and custom edge IDs.

Parameters:

baseGraph - the base graph which does not necessarily support custom IDs

IdGraph

public IdGraph(T baseGraph,
       boolean supportVertexIds,
       boolean supportEdgeIds)

Adds custom ID functionality to the given graph, supporting either custom vertex IDs, custom edge IDs, or both.

Parameters:

baseGraph - the base graph which does not necessarily support custom IDs

supportVertexIds - whether to support custom vertex IDs

supportEdgeIds - whether to support custom edge IDs

Method Detail

setVertexIdFactory

public void setVertexIdFactory(IdGraph.IdFactory idFactory)

Parameters:

idFactory - a factory for new vertex IDs. When vertices are created using null IDs, the actual IDs are chosen based on this factory.

setEdgeIdFactory

public void setEdgeIdFactory(IdGraph.IdFactory idFactory)

Parameters:

idFactory - a factory for new edge IDs. When edges are created using null IDs, the actual IDs are chosen based on this factory.

getVertexIdFactory

public IdGraph.IdFactory getVertexIdFactory()

Returns:

the factory for new vertex IDs. When vertices are created using null IDs, the actual IDs are chosen based on this factory.

getEdgeIdFactory

public IdGraph.IdFactory getEdgeIdFactory()

return the factory for new edge IDs. When edges are created using null IDs, the actual IDs are chosen based on this factory.

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

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

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

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

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

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

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

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

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

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

stopTransaction

public void stopTransaction(TransactionalGraph.Conclusion conclusion)

Description copied from interface: TransactionalGraph

Stop the current transaction. Specify whether the transaction was successful or not. A failing transaction will rollback all updates to before the transaction was started. If there is currently no open transaction (i.e. no operations on the graph), then calling this method has no effect other than potentially re-initializing data structures.

Specified by:

stopTransaction in interface TransactionalGraph

Parameters:

conclusion - whether or not the current transaction was successful

rollback

public void rollback()

Description copied from interface: TransactionalGraph

Stop the current transaction and drop any mutations applied since the last transaction.

Specified by:

rollback in interface TransactionalGraph

commit

public void commit()

Description copied from interface: TransactionalGraph

Stop the current transaction and successfully apply mutations to the graph.

Specified by:

commit in interface TransactionalGraph

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

toString

public String toString()

Overrides:

toString in class Object

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

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

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

getBaseGraph

public T getBaseGraph()

Description copied from interface: WrapperGraph

Get the graph this wrapper delegates to.

Specified by:

getBaseGraph in interface WrapperGraph<T extends KeyIndexableGraph>

Returns:

the underlying graph that this WrapperGraph delegates its operations to.

enforceUniqueIds

public void enforceUniqueIds(boolean enforceUniqueIds)

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

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

getSupportVertexIds

public boolean getSupportVertexIds()

getSupportEdgeIds

public boolean getSupportEdgeIds()