com.tinkerpop.blueprints.util.wrappers.partition

Class PartitionGraph<T extends Graph>

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.partition.PartitionGraph<T>

All Implemented Interfaces:

Graph, WrapperGraph<T>

Direct Known Subclasses:

PartitionIndexableGraph

public class PartitionGraph<T extends Graph>
extends Object
implements Graph, WrapperGraph<T>

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected T	baseGraph

Constructor Summary

Constructors

Constructor and Description
PartitionGraph(T baseGraph, String partitionKey, String readWritePartition)
PartitionGraph(T baseGraph, String partitionKey, String writePartition, Set<String> readPartitions)

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.
void	addReadPartition(String readPartition)
Vertex	addVertex(Object id) Create a new vertex, add it to the graph, and return the newly created vertex.
T	getBaseGraph() Get the graph this wrapper delegates to.
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.
String	getPartitionKey()
Set<String>	getReadPartitions()
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.
String	getWritePartition()
boolean	isInPartition(Element element)
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	removeReadPartition(String readPartition)
void	removeVertex(Vertex vertex) Remove the provided vertex from the graph.
void	setPartitionKey(String partitionKey)
void	setWritePartition(String writePartition)
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

baseGraph

protected T extends Graph baseGraph

Constructor Detail

PartitionGraph

public PartitionGraph(T baseGraph,
              String partitionKey,
              String writePartition,
              Set<String> readPartitions)

PartitionGraph

public PartitionGraph(T baseGraph,
              String partitionKey,
              String readWritePartition)

Method Detail

getWritePartition

public String getWritePartition()

setWritePartition

public void setWritePartition(String writePartition)

getReadPartitions

public Set<String> getReadPartitions()

removeReadPartition

public void removeReadPartition(String readPartition)

addReadPartition

public void addReadPartition(String readPartition)

setPartitionKey

public void setPartitionKey(String partitionKey)

getPartitionKey

public String getPartitionKey()

isInPartition

public boolean isInPartition(Element element)

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

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

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

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

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

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

getBaseGraph

public T getBaseGraph()

Description copied from interface: WrapperGraph

Get the graph this wrapper delegates to.

Specified by:

getBaseGraph in interface WrapperGraph<T extends Graph>

Returns:

the underlying graph that this WrapperGraph delegates its operations to.

toString

public String toString()

Overrides:

toString in class Object

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

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