org.springframework.data.neo4j.template

Interface Neo4jOperations

All Known Implementing Classes:

Neo4jTemplate

@Repository
public interface Neo4jOperations

Spring Data operations interface, implemented by Neo4jTemplate, that provides the API for using the persistence framework in a more direct way as an alternative to the repositories.

Author:

Adam George, Luanne Misquitta

Method Summary

Modifier and Type	Method and Description
long	count(Class<?> entityClass) Provides the instance count for the given node entity type.
void	delete(Object entity) Removes the given node or relationship entity from the graph.
org.neo4j.ogm.session.result.QueryStatistics	execute(String cypherQuery) Deprecated. Use Neo4jOperations.query() to return both results as well as query statistics.
org.neo4j.ogm.session.result.QueryStatistics	execute(String cypher, Map<String,Object> parameters) Deprecated. Use Neo4jOperations.query() to return both results as well as query statistics.
<T> T	load(Class<T> type, Long id) Loads an entity of type T that matches the specified ID to the default depth.
<T> T	load(Class<T> type, Long id, int depth) Loads an entity of type T that matches the specified ID to the given depth.
<T> Collection<T>	loadAll(Class<T> type) Retrieves all the entities of the given class in the database hydrated to the default depth.
<T> Collection<T>	loadAll(Class<T> type, int depth) Retrieves all the entities of the given class in the database hydrated to the specified depth.
<T> Collection<T>	loadAll(Collection<T> objects, int depth) Reloads all of the entities in the given Collection to the specified depth.
<T> Collection<T>	loadAllByProperties(Class<T> type, org.neo4j.ogm.cypher.Filters parameters) Retrieves all the entities of the specified type that contain a properties matching the ones supplied with given name and value.
<T> Collection<T>	loadAllByProperty(Class<T> type, String propertyName, Object propertyValue) Retrieves all the entities of the specified type that contain a property matching the given name with the given value.
<T> T	loadByProperties(Class<T> type, org.neo4j.ogm.cypher.Filters parameters) Retrieves the entity of the specified type that contains properties matching the ones supplied with given name and value.
<T> T	loadByProperty(Class<T> type, String propertyName, Object propertyValue) Retrieves the entity of the specified type that contains a property matching the given name with the given value.
org.neo4j.ogm.session.result.Result	query(String cypherQuery, Map<String,?> params) Executes the specified Cypher query with the given parameters against the underlying Neo4j database and returns the row-based result in the form of an Iterable of Maps.
org.neo4j.ogm.session.result.Result	query(String cypher, Map<String,?> parameters, boolean readOnly) Given a cypher statement this method will return a Result object containing a collection of Map's which represent Neo4j objects as properties, along with query statistics if applicable.
<T> T	queryForObject(Class<T> entityType, String cypherQuery, Map<String,?> parameters) Runs the specified Cypher query with the given parameters against the underlying Neo4j database and returns the result marshalled as an object of the requested type.
<T> Iterable<T>	queryForObjects(Class<T> entityType, String cypherQuery, Map<String,?> parameters) Runs the specified Cypher query with the given parameters against the underlying Neo4j database and returns the result marshalled as a group of objects of the requested type.
<T> T	save(T entity) Saves the specified entity in the graph database.

Method Detail

load

<T> T load(Class<T> type,
           Long id)

Loads an entity of type T that matches the specified ID to the default depth.

Parameters:

type - The type of entity to load

id - The ID of the node or relationship to match

Returns:

The instance of T loaded from the database that matches the specified ID or null if no match is found

load

<T> T load(Class<T> type,
           Long id,
           int depth)

Loads an entity of type T that matches the specified ID to the given depth.

Parameters:

type - The type of entity to load

id - The ID of the node or relationship to match

depth - The maximum number of relationships away from the identified object to follow when loading related entities. A value of 0 just loads the object's properties and no related entities. A value of -1 implies no depth limit.

Returns:

The instance of T loaded from the database that matches the specified ID or null if no match is found

loadAll

<T> Collection<T> loadAll(Class<T> type)

Retrieves all the entities of the given class in the database hydrated to the default depth.

Parameters:

type - The type of entity to return.

Returns:

A Collection containing all instances of the given type in the database or an empty collection if none are found, never null

loadAll

<T> Collection<T> loadAll(Class<T> type,
                          int depth)

Retrieves all the entities of the given class in the database hydrated to the specified depth.

Parameters:

type - The type of entity to return.

depth - The maximum number of relationships away from each loaded object to follow when loading related entities. A value of 0 just loads the object's properties and no related entities. A value of -1 implies no depth limit.

Returns:

A Collection containing all instances of the given type in the database or an empty collection if none are found, never null

loadAll

<T> Collection<T> loadAll(Collection<T> objects,
                          int depth)

Reloads all of the entities in the given Collection to the specified depth. Of course, this will only work for persistent objects (i.e., those with a non-null @GraphId field).

Parameters:

objects - The objects to re-hydrate

depth - The depth to which the objects should be hydrated

Returns:

A new Collection of entities matching those in the given collection hydrated to the given depth

loadByProperty

<T> T loadByProperty(Class<T> type,
                     String propertyName,
                     Object propertyValue)

Retrieves the entity of the specified type that contains a property matching the given name with the given value. This method assumes that the requested property/value combination will be unique for all entities of this type in the database and will throw an exception unless exactly one result is found. If several entities are expected to be returned then use loadAllByProperty(Class, String, Object) instead.

Parameters:

type - The type of entity to load

propertyName - The name of the property on the entity against which to match the given value

propertyValue - The value of the named property against which to match entities

Returns:

The instance of T corresponding to the entity that matches the given property, never null

Throws:

NotFoundException - if there are no matching entities

IllegalStateException - if there's more than one matching entity

loadAllByProperty

<T> Collection<T> loadAllByProperty(Class<T> type,
                                    String propertyName,
                                    Object propertyValue)

Retrieves all the entities of the specified type that contain a property matching the given name with the given value.

Parameters:

type - The type of entity to load

propertyName - The name of the property on the entity against which to match the given value

propertyValue - The value of the named property against which to match entities

Returns:

A Collection containing all the entities that match the given property or an empty Collection if there aren't any matches, never null

loadByProperties

<T> T loadByProperties(Class<T> type,
                       org.neo4j.ogm.cypher.Filters parameters)

Retrieves the entity of the specified type that contains properties matching the ones supplied with given name and value. This method assumes that the requested property/value combinations will be unique for all entities of this type in the database and will throw an exception unless exactly one result is found. If several entities are expected to be returned then use loadAllByProperty(Class, String, Object) instead.

Parameters:

type - The type of entity to load

parameters - The parameters to filter by

Returns:

The instance of T corresponding to the entity that matches the given properties, never null

Throws:

NotFoundException - if there are no matching entities

IllegalStateException - if there's more than one matching entity

loadAllByProperties

<T> Collection<T> loadAllByProperties(Class<T> type,
                                      org.neo4j.ogm.cypher.Filters parameters)

Retrieves all the entities of the specified type that contain a properties matching the ones supplied with given name and value.

Parameters:

type - The type of entity to load

parameters - The parameters to filter by

Returns:

A Collection containing all the entities that match the given properties or an empty Collection if there aren't any matches, never null

save

<T> T save(T entity)

Saves the specified entity in the graph database. If the entity is currently transient then the persistent version of the entity will be returned, containing its new graph ID.

Parameters:

entity - The entity to save

Returns:

The saved entity

delete

void delete(Object entity)

Removes the given node or relationship entity from the graph. The entity is first removed from all indexes and then deleted.

Parameters:

entity - The entity to delete

query

org.neo4j.ogm.session.result.Result query(String cypherQuery,
                                          Map<String,?> params)

Executes the specified Cypher query with the given parameters against the underlying Neo4j database and returns the row-based result in the form of an Iterable of Maps.

Each of the resultant maps corresponds to a "row" in the result set and the key set in each map contains all the names contained in the RETURN clause of the given query.

Parameters:

cypherQuery - The Cypher query to execute

params - The parameter to merge into the cypher query or an empty Map if the given query isn't parameterised

Returns:

A Result containing an Iterable map representing query results and QueryStatistics if applicable.

Throws:

RuntimeException - if the given query is not a valid Cypherquery

queryForObject

<T> T queryForObject(Class<T> entityType,
                     String cypherQuery,
                     Map<String,?> parameters)

Runs the specified Cypher query with the given parameters against the underlying Neo4j database and returns the result marshalled as an object of the requested type.

Parameters:

entityType - The Class denoting the type of entity to return

cypherQuery - The Cypher query to execute

parameters - The parameter to merge into the Cypher query or an empty Map if the query's not parameterised

Returns:

An instance of T that corresponds to the entity found by executing the query or null if nothing is found by the query

Throws:

RuntimeException - If more than one result is returned or there's an issue executing the query

queryForObjects

<T> Iterable<T> queryForObjects(Class<T> entityType,
                                String cypherQuery,
                                Map<String,?> parameters)

Runs the specified Cypher query with the given parameters against the underlying Neo4j database and returns the result marshalled as a group of objects of the requested type.

Parameters:

entityType - The Class denoting the type of entity to return

cypherQuery - The Cypher query to execute

parameters - The parameter to merge into the Cypher query or an empty Map if the query's not parameterised

Returns:

An Iterable over the entities found by executing the query or an empty Iterable if nothing is found by the query, never null

Throws:

RuntimeException - If there's an issue executing the query

query

org.neo4j.ogm.session.result.Result query(String cypher,
                                          Map<String,?> parameters,
                                          boolean readOnly)

Given a cypher statement this method will return a Result object containing a collection of Map's which represent Neo4j objects as properties, along with query statistics if applicable. Each element of the query result is a map which you can access by the name of the returned field TODO: Are we going to use the neo4jOperations conversion method to cast the value object to its proper class?

Parameters:

cypher - The parametrisable cypher to execute.

parameters - Any parameters to attach to the cypher.

readOnly - true if the query is readOnly, false otherwise

Returns:

A Result of Iterables with each entry representing a neo4j object's properties.

execute

@Deprecated
org.neo4j.ogm.session.result.QueryStatistics execute(String cypherQuery)

Deprecated. Use Neo4jOperations.query() to return both results as well as query statistics.

/** Issue a single Cypher update operation (such as a CREATE, MERGE or DELETE statement).

Parameters:

cypherQuery - The Cypher query to execute

Returns:

QueryStatistics representing statistics about graph modifications as a result of the cypher execution.

execute

@Deprecated
org.neo4j.ogm.session.result.QueryStatistics execute(String cypher,
                                                                 Map<String,Object> parameters)

Deprecated. Use Neo4jOperations.query() to return both results as well as query statistics.

Allows a cypher statement with a modification statement to be executed.

Parameters may be scalars or domain objects themselves.

Parameters:

cypher - The parametrisable cypher to execute.

parameters - Any parameters to attach to the cypher. These may be domain objects or scalars. Note that if a complex domain object is provided only the properties of that object will be set. If relationships of a provided object also need to be set then the cypher should reflect this and further domain object parameters provided.

Returns:

QueryStatistics representing statistics about graph modifications as a result of the cypher execution.

count

long count(Class<?> entityClass)

Provides the instance count for the given node entity type. This method is also provided by the corresponding repository.

Parameters:

entityClass - The Class representing the type of node entity to count

Returns:

The number of entities in the database of the given type