com.tinkerpop.blueprints

Interface Graph

All Known Subinterfaces:

IndexableGraph, KeyIndexableGraph, MetaGraph<T>, ThreadedTransactionalGraph, TransactionalGraph

All Known Implementing Classes:

BatchGraph, EventGraph, EventIndexableGraph, EventTransactionalGraph, EventTransactionalIndexableGraph, IdGraph, PartitionGraph, PartitionIndexableGraph, ReadOnlyGraph, ReadOnlyIndexableGraph, ReadOnlyKeyIndexableGraph, TinkerGraph, WrappedGraph, WrappedIndexableGraph

public interface Graph

A Graph is a container object for a collection of vertices and a collection edges.

Author:

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

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.
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.
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.

Method Detail

getFeatures

Features getFeatures()

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.

Returns:

the features of this particular Graph implementation

addVertex

Vertex addVertex(Object id)

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.

Parameters:

id - the recommended object identifier

Returns:

the newly created vertex

getVertex

Vertex getVertex(Object id)

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

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

void removeVertex(Vertex vertex)

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.

Parameters:

vertex - the vertex to remove from the graph

getVertices

Iterable<Vertex> getVertices()

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

Returns:

an iterable reference to all vertices in the graph

getVertices

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

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.

Parameters:

key - the key of vertex

value - the value of the vertex

Returns:

an iterable of vertices with provided key and value

addEdge

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

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.

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

Edge getEdge(Object id)

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

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

void removeEdge(Edge edge)

Remove the provided edge from the graph.

Parameters:

edge - the edge to remove from the graph

getEdges

Iterable<Edge> getEdges()

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

Returns:

an iterable reference to all edges in the graph

getEdges

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

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.

Parameters:

key - the key of the edge

value - the value of the edge

Returns:

an iterable of edges with provided key and value

query

GraphQuery query()

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

Returns:

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

shutdown

void shutdown()

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