org.calrissian.accumulorecipes.graphstore.tinkerpop

Class EntityGraph

java.lang.Object

org.calrissian.accumulorecipes.graphstore.tinkerpop.EntityGraph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph

public class EntityGraph
extends Object
implements com.tinkerpop.blueprints.Graph

This is a read-only implementation of the Tinkerpop Blueprints graph model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityGraph.EdgeEntityXform A config function to turn an Entity into an EntityEdge
static class	EntityGraph.EdgeToVertexIndexXform This config function will pull the vertex index from the correct side of given the edge based on the given direction and will structure the result as an index to be used to query the entity store.
static class	EntityGraph.EntityFilterPredicate<T extends com.tinkerpop.blueprints.Element>
static class	EntityGraph.EntityIndexXform A config function to turn an EntityElement into an EntityIndex so that it can be directly applied to the EntityStore.
static class	EntityGraph.VertexEntityXform A config function to turn an Entity into an EntityVertex.

Field Summary

Fields

Modifier and Type	Field and Description
protected Auths	auths
protected Set<String>	edgeTypes
protected GraphStore	graphStore
protected Set<String>	vertexTypes

Constructor Summary

Constructors

Constructor and Description
EntityGraph(GraphStore graphStore, Set<String> vertexTypes, Set<String> edgeTypes, Auths auths) The graph is restriced only to the given vertex types and edge types.

Method Summary

Methods

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Edge	addEdge(Object o, com.tinkerpop.blueprints.Vertex vertex, com.tinkerpop.blueprints.Vertex vertex2, String s) Adding edges is not allowed because this store is read-only
com.tinkerpop.blueprints.Vertex	addVertex(Object o) Adding a vertex is not allowed because the graph store is read-only
com.tinkerpop.blueprints.Edge	getEdge(Object entityIndex) Retrieves the edge at the specified EntityIndex.
org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Edge>	getEdges() Returns all edges with the entity edge types configured on this instance
org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Edge>	getEdges(String key, Object value) Returns edges with the given property key and value.
com.tinkerpop.blueprints.Features	getFeatures()
com.tinkerpop.blueprints.Vertex	getVertex(Object entityIndex) Retrieves the vertex with the given EntityIndex
org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVertices() Retrieves all the vertices with the given vertex types configured on the current instance
org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVertices(String key, Object value) Retrieves the vertices with the given property key and value
com.tinkerpop.blueprints.GraphQuery	query() Returns a graph query builder object
void	removeEdge(com.tinkerpop.blueprints.Edge edge) The store is read-only so edges cannot be removed.
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex) Removing a vertex is not allowed because the graph is read-only
void	shutdown()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

graphStore

protected GraphStore graphStore

vertexTypes

protected Set<String> vertexTypes

edgeTypes

protected Set<String> edgeTypes

auths

protected Auths auths

Constructor Detail

EntityGraph

public EntityGraph(GraphStore graphStore,
           Set<String> vertexTypes,
           Set<String> edgeTypes,
           Auths auths)

The graph is restriced only to the given vertex types and edge types. This allows only a smaller portion of the larger graph to be traversed as if those are the only types that exist. The given auths are applied directly to every query so that the results are further restricted.

Method Detail

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Specified by:

getFeatures in interface com.tinkerpop.blueprints.Graph

addVertex

public com.tinkerpop.blueprints.Vertex addVertex(Object o)

Adding a vertex is not allowed because the graph store is read-only

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(Object entityIndex)

Retrieves the vertex with the given EntityIndex

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

removeVertex

public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)

Removing a vertex is not allowed because the graph is read-only

Specified by:

removeVertex in interface com.tinkerpop.blueprints.Graph

getVertices

public org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVertices()

Retrieves all the vertices with the given vertex types configured on the current instance

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getVertices

public org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVertices(String key,
                                                                                          Object value)

Retrieves the vertices with the given property key and value

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

addEdge

public com.tinkerpop.blueprints.Edge addEdge(Object o,
                                    com.tinkerpop.blueprints.Vertex vertex,
                                    com.tinkerpop.blueprints.Vertex vertex2,
                                    String s)

Adding edges is not allowed because this store is read-only

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

getEdge

public com.tinkerpop.blueprints.Edge getEdge(Object entityIndex)

Retrieves the edge at the specified EntityIndex.

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

Parameters:

entityIndex - The entity index object (type and id) for which to find the edge

removeEdge

public void removeEdge(com.tinkerpop.blueprints.Edge edge)

The store is read-only so edges cannot be removed.

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

getEdges

public org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Edge> getEdges()

Returns all edges with the entity edge types configured on this instance

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getEdges

public org.calrissian.mango.collect.CloseableIterable<com.tinkerpop.blueprints.Edge> getEdges(String key,
                                                                                     Object value)

Returns edges with the given property key and value.

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

query

public com.tinkerpop.blueprints.GraphQuery query()

Returns a graph query builder object

Specified by:

query in interface com.tinkerpop.blueprints.Graph

shutdown

public void shutdown()

Specified by:

shutdown in interface com.tinkerpop.blueprints.Graph

toString

public String toString()

Overrides:

toString in class Object