eu.ehri.project.core.impl.neo4j

Class Neo4j2Graph

java.lang.Object

eu.ehri.project.core.impl.neo4j.Neo4j2Graph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.MetaGraph<org.neo4j.graphdb.GraphDatabaseService>, com.tinkerpop.blueprints.TransactionalGraph

Direct Known Subclasses:

TxNeo4jGraph

public class Neo4j2Graph
extends Object
implements com.tinkerpop.blueprints.TransactionalGraph, com.tinkerpop.blueprints.MetaGraph<org.neo4j.graphdb.GraphDatabaseService>

A Blueprints implementation of the graph database Neo4j (http://neo4j.org)

Nested Class Summary

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

com.tinkerpop.blueprints.TransactionalGraph.Conclusion

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal<Boolean>	checkElementsInTransaction
protected ThreadLocal<org.neo4j.graphdb.Transaction>	tx

Constructor Summary

Constructors

Constructor and Description
Neo4j2Graph(org.apache.commons.configuration.Configuration configuration)
Neo4j2Graph(org.neo4j.graphdb.GraphDatabaseService rawGraph)
Neo4j2Graph(String directory)
Neo4j2Graph(String directory, Map<String,String> configuration)

Method Summary

Modifier and Type	Method and Description
Neo4j2Edge	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label)
Neo4j2Vertex	addVertex(Object id)
void	autoStartTransaction(boolean forWrite)
protected boolean	checkElementsInTransaction()
void	commit()
Neo4j2Edge	getEdge(Object id)
Iterable<com.tinkerpop.blueprints.Edge>	getEdges()
Iterable<com.tinkerpop.blueprints.Edge>	getEdges(String key, Object value)
com.tinkerpop.blueprints.Features	getFeatures()
org.neo4j.graphdb.GraphDatabaseService	getRawGraph()
Neo4j2Vertex	getVertex(Object id)
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices()
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(String key, Object value)
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVerticesByLabel(String label)
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVerticesByLabelKeyValue(String label, String key, Object value)
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	getVerticesByQuery(String query, Map<String,Object> params, String column) Get an iterable of vertices via a Cypher query.
protected void	init()
com.tinkerpop.blueprints.GraphQuery	query()
com.tinkerpop.blueprints.CloseableIterable<Map<String,Object>>	query(String query, Map<String,Object> params)
void	removeEdge(com.tinkerpop.blueprints.Edge edge)
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex)
void	rollback()
void	shutdown()
void	stopTransaction(com.tinkerpop.blueprints.TransactionalGraph.Conclusion conclusion)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

tx

protected final ThreadLocal<org.neo4j.graphdb.Transaction> tx

checkElementsInTransaction

protected final ThreadLocal<Boolean> checkElementsInTransaction

Constructor Detail

Neo4j2Graph

public Neo4j2Graph(String directory)

Neo4j2Graph

public Neo4j2Graph(org.neo4j.graphdb.GraphDatabaseService rawGraph)

Neo4j2Graph

public Neo4j2Graph(String directory,
                   Map<String,String> configuration)

Neo4j2Graph

public Neo4j2Graph(org.apache.commons.configuration.Configuration configuration)

Method Detail

checkElementsInTransaction

protected boolean checkElementsInTransaction()

init

protected void init()

addVertex

public Neo4j2Vertex addVertex(Object id)

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

getVertex

public Neo4j2Vertex getVertex(Object id)

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

getVertices

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

The underlying Neo4j graph does not natively support this method within a transaction. If the graph is not currently in a transaction, then the operation runs efficiently and correctly. If the graph is currently in a transaction, please use setCheckElementsInTransaction() if it is necessary to ensure proper transactional semantics. Note that it is costly to check if an element is in the transaction.

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

Returns:

all the vertices in the graph

getVerticesByLabel

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVerticesByLabel(String label)

getVerticesByLabelKeyValue

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVerticesByLabelKeyValue(String label,
                                                                                                              String key,
                                                                                                              Object value)

getVerticesByQuery

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> getVerticesByQuery(String query,
                                                                                                      Map<String,Object> params,
                                                                                                      String column)

Get an iterable of vertices via a Cypher query.

Parameters:

query - the cypher query

params - a map of parameters

column - the name of the column from which to extract the vertices. The column must be a node or a class cast exception will be thrown when the iterable is accessed

Returns:

an iterable of vertices

getVertices

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

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges()

The underlying Neo4j graph does not natively support this method within a transaction. If the graph is not currently in a transaction, then the operation runs efficiently and correctly. If the graph is currently in a transaction, please use setCheckElementsInTransaction() if it is necessary to ensure proper transactional semantics. Note that it is costly to check if an element is in the transaction.

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

Returns:

all the edges in the graph

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges(String key,
                                                        Object value)

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

removeVertex

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

Specified by:

removeVertex in interface com.tinkerpop.blueprints.Graph

addEdge

public Neo4j2Edge addEdge(Object id,
                          com.tinkerpop.blueprints.Vertex outVertex,
                          com.tinkerpop.blueprints.Vertex inVertex,
                          String label)

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

getEdge

public Neo4j2Edge getEdge(Object id)

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

removeEdge

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

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

stopTransaction

public void stopTransaction(com.tinkerpop.blueprints.TransactionalGraph.Conclusion conclusion)

Specified by:

stopTransaction in interface com.tinkerpop.blueprints.TransactionalGraph

commit

public void commit()

Specified by:

commit in interface com.tinkerpop.blueprints.TransactionalGraph

rollback

public void rollback()

Specified by:

rollback in interface com.tinkerpop.blueprints.TransactionalGraph

shutdown

public void shutdown()

Specified by:

shutdown in interface com.tinkerpop.blueprints.Graph

autoStartTransaction

public void autoStartTransaction(boolean forWrite)

getRawGraph

public org.neo4j.graphdb.GraphDatabaseService getRawGraph()

Specified by:

getRawGraph in interface com.tinkerpop.blueprints.MetaGraph<org.neo4j.graphdb.GraphDatabaseService>

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Specified by:

getFeatures in interface com.tinkerpop.blueprints.Graph

toString

public String toString()

Overrides:

toString in class Object

query

public com.tinkerpop.blueprints.GraphQuery query()

Specified by:

query in interface com.tinkerpop.blueprints.Graph

query

public com.tinkerpop.blueprints.CloseableIterable<Map<String,Object>> query(String query,
                                                                            Map<String,Object> params)