eu.ehri.project.core.impl

Class BlueprintsGraphManager<T extends com.tinkerpop.blueprints.Graph>

java.lang.Object

eu.ehri.project.core.impl.BlueprintsGraphManager<T>

All Implemented Interfaces:

GraphManager

Direct Known Subclasses:

Neo4jGraphManager

public class BlueprintsGraphManager<T extends com.tinkerpop.blueprints.Graph>
extends Object
implements GraphManager

Implementation of GraphManager that uses a single index to manage all nodes.

This class can be extended for when specific graph implementations (such as Neo4j) can provide more efficient implementations of certain methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.tinkerpop.frames.FramedGraph<T>	graph
protected static String	METADATA_PREFIX

Constructor Summary

Constructors

Constructor and Description
BlueprintsGraphManager(com.tinkerpop.frames.FramedGraph<T> graph)

Method Summary

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Vertex	createVertex(String id, EntityClass type, Map<String,?> data) Create a vertex with the given id, type, and data.
void	deleteVertex(String id) Delete a vertex with the given ID.
void	deleteVertex(com.tinkerpop.blueprints.Vertex vertex) Delete the given vertex.
boolean	exists(String id) Check if a node with the given ID exists or not.
<E> com.tinkerpop.blueprints.CloseableIterable<E>	getEntities(EntityClass type, Class<E> cls) Get an Iterable of vertices of the given type, frames with the given interface class.
<E> com.tinkerpop.blueprints.CloseableIterable<E>	getEntities(String key, Object value, EntityClass type, Class<E> cls) Get a CloseableIterable of entities with the given type, and the given key/value property.
<E> E	getEntity(String id, Class<E> cls) Get a node with the given ID, and frame it with the given interface class.
<E> E	getEntity(String id, EntityClass type, Class<E> cls) Get a node with the given ID and type, framing it with the given interface class.
EntityClass	getEntityClass(Entity entity) Get the type of an arbitrary framed vertex.
EntityClass	getEntityClass(com.tinkerpop.blueprints.Vertex vertex) Get the type of an arbitrary vertex.
com.tinkerpop.frames.FramedGraph<T>	getGraph() Get a pointer to the underlying graph.
String	getId(com.tinkerpop.blueprints.Vertex vertex) Get the id of a given vertex.
Map<String,Object>	getProperties(com.tinkerpop.blueprints.Vertex vertex) Get a vertex's properties.
String	getType(com.tinkerpop.blueprints.Vertex vertex) Get the id of a given vertex.
com.tinkerpop.blueprints.Vertex	getVertex(String id) Get a node with the given ID.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVertices(EntityClass type) Get a CloseableIterable of vertices with the given entity class.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVertices(Iterable<String> ids) Get a CloseableIterable of vertices with the given ids.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVertices(String key, Object value, EntityClass type) Get a CloseableIterable of vertices with the given type, and the given key/value property.
void	initialize()
void	renameVertex(com.tinkerpop.blueprints.Vertex vertex, String oldId, String newId) Rename an existing vertex, changing its ID.
void	setProperty(com.tinkerpop.blueprints.Vertex vertex, String key, Object value) Set a property on a vertex.
com.tinkerpop.blueprints.Vertex	updateVertex(String id, EntityClass type, Map<String,?> data) Create a vertex with the given id, type, and data.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_PREFIX

protected static final String METADATA_PREFIX

See Also:

Constant Field Values

graph

protected final com.tinkerpop.frames.FramedGraph<T extends com.tinkerpop.blueprints.Graph> graph

Constructor Detail

BlueprintsGraphManager

public BlueprintsGraphManager(com.tinkerpop.frames.FramedGraph<T> graph)

Method Detail

getGraph

public com.tinkerpop.frames.FramedGraph<T> getGraph()

Description copied from interface: GraphManager

Get a pointer to the underlying graph.

Specified by:

getGraph in interface GraphManager

getId

public String getId(com.tinkerpop.blueprints.Vertex vertex)

Description copied from interface: GraphManager

Get the id of a given vertex.

Specified by:

getId in interface GraphManager

Parameters:

vertex - A vertex

Returns:

The vertex's string ID

getType

public String getType(com.tinkerpop.blueprints.Vertex vertex)

Description copied from interface: GraphManager

Get the id of a given vertex.

Specified by:

getType in interface GraphManager

Parameters:

vertex - A vertex

Returns:

The vertex's string type

getProperties

public Map<String,Object> getProperties(com.tinkerpop.blueprints.Vertex vertex)

Description copied from interface: GraphManager

Get a vertex's properties.

Specified by:

getProperties in interface GraphManager

Returns:

a map of property objects

getEntityClass

public EntityClass getEntityClass(com.tinkerpop.blueprints.Vertex vertex)

Description copied from interface: GraphManager

Get the type of an arbitrary vertex.

Specified by:

getEntityClass in interface GraphManager

Parameters:

vertex - A vertex

Returns:

The vertex's entity class

getEntityClass

public EntityClass getEntityClass(Entity entity)

Description copied from interface: GraphManager

Get the type of an arbitrary framed vertex.

Specified by:

getEntityClass in interface GraphManager

Parameters:

entity - A framed vertex

Returns:

The entity's entity class

exists

public boolean exists(String id)

Description copied from interface: GraphManager

Check if a node with the given ID exists or not.

Specified by:

exists in interface GraphManager

Parameters:

id - A string id

Returns:

Whether or not a node with that ID exists in the graph.

getEntity

public <E> E getEntity(String id,
                       Class<E> cls)
                throws ItemNotFound

Description copied from interface: GraphManager

Get a node with the given ID, and frame it with the given interface class.

Specified by:

getEntity in interface GraphManager

Parameters:

id - The vertex's string ID

cls - The desired frame class

Returns:

The framed vertex

Throws:

ItemNotFound

getEntity

public <E> E getEntity(String id,
                       EntityClass type,
                       Class<E> cls)
                throws ItemNotFound

Description copied from interface: GraphManager

Get a node with the given ID and type, framing it with the given interface class.

Specified by:

getEntity in interface GraphManager

Parameters:

id - The vertex's string ID

type - The entity type

cls - The desired frame class

Returns:

The framed vertex

Throws:

ItemNotFound

getEntities

public <E> com.tinkerpop.blueprints.CloseableIterable<E> getEntities(EntityClass type,
                                                                     Class<E> cls)

Description copied from interface: GraphManager

Get an Iterable of vertices of the given type, frames with the given interface class.

Specified by:

getEntities in interface GraphManager

Parameters:

type - The entity type

Returns:

An iterable of framed vertices with the given framed class.

getEntities

public <E> com.tinkerpop.blueprints.CloseableIterable<E> getEntities(String key,
                                                                     Object value,
                                                                     EntityClass type,
                                                                     Class<E> cls)

Description copied from interface: GraphManager

Get a CloseableIterable of entities with the given type, and the given key/value property.

Specified by:

getEntities in interface GraphManager

Parameters:

key - the property key

value - property value

type - the entity type

Returns:

an iterable of entities with the given key/value properties

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(String id)
                                          throws ItemNotFound

Description copied from interface: GraphManager

Get a node with the given ID.

Specified by:

getVertex in interface GraphManager

Parameters:

id - The vertex's string ID

Returns:

The vertex

Throws:

ItemNotFound

getVertices

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVertices(EntityClass type)

Description copied from interface: GraphManager

Get a CloseableIterable of vertices with the given entity class.

Specified by:

getVertices in interface GraphManager

Parameters:

type - The entity type

Returns:

An iterable of vertices belonging to that entity class

getVertices

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVertices(Iterable<String> ids)

Description copied from interface: GraphManager

Get a CloseableIterable of vertices with the given ids.

Specified by:

getVertices in interface GraphManager

Parameters:

ids - An iterable of String IDs

Returns:

An iterable of vertices with the given IDs. If a vertex is not found the value at the place in the input iterable will be null.

getVertices

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVertices(String key,
                                                                                               Object value,
                                                                                               EntityClass type)

Description copied from interface: GraphManager

Get a CloseableIterable of vertices with the given type, and the given key/value property.

Specified by:

getVertices in interface GraphManager

Parameters:

key - the property key

value - property value

type - the entity type

Returns:

an iterable of vertices with the given key/value properties

createVertex

public com.tinkerpop.blueprints.Vertex createVertex(String id,
                                                    EntityClass type,
                                                    Map<String,?> data)
                                             throws IntegrityError

Description copied from interface: GraphManager

Create a vertex with the given id, type, and data.

Specified by:

createVertex in interface GraphManager

Parameters:

id - The vertex's string ID

type - The entity type

data - The data map

Returns:

The new vertex

Throws:

IntegrityError - if an item with the given id already exists

updateVertex

public com.tinkerpop.blueprints.Vertex updateVertex(String id,
                                                    EntityClass type,
                                                    Map<String,?> data)
                                             throws ItemNotFound

Description copied from interface: GraphManager

Create a vertex with the given id, type, and data.

Specified by:

updateVertex in interface GraphManager

Parameters:

id - The vertex's string ID

type - The entity type

data - The data map

Returns:

The updated vertex

Throws:

ItemNotFound

setProperty

public void setProperty(com.tinkerpop.blueprints.Vertex vertex,
                        String key,
                        Object value)

Description copied from interface: GraphManager

Set a property on a vertex.

Specified by:

setProperty in interface GraphManager

Parameters:

vertex - The vertex

key - The property key

value - The property value

renameVertex

public void renameVertex(com.tinkerpop.blueprints.Vertex vertex,
                         String oldId,
                         String newId)

Description copied from interface: GraphManager

Rename an existing vertex, changing its ID.

Specified by:

renameVertex in interface GraphManager

Parameters:

vertex - the vertex

oldId - the old ID

newId - the new ID

deleteVertex

public void deleteVertex(String id)
                  throws ItemNotFound

Description copied from interface: GraphManager

Delete a vertex with the given ID.

Specified by:

deleteVertex in interface GraphManager

Parameters:

id - The vertex's string ID

Throws:

ItemNotFound

deleteVertex

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

Description copied from interface: GraphManager

Delete the given vertex.

Specified by:

deleteVertex in interface GraphManager

Parameters:

vertex - The vertex to delete

initialize

public void initialize()

Specified by:

initialize in interface GraphManager