org.neo4j.ogm.session

Interface Capability.ExecuteQueries

All Known Subinterfaces:

Session

All Known Implementing Classes:

ExecuteQueriesDelegate, Neo4jSession

Enclosing interface:

Capability

public static interface Capability.ExecuteQueries

Method Summary

Methods

Modifier and Type	Method and Description
long	countEntitiesOfType(Class<?> entity) Counts all the node entities of the specified type.
<T> Iterable<T>	query(Class<T> objectType, String cypher, Map<String,?> parameters) Given a cypher statement this method will return a collection of domain objects that is hydrated to the default level or a collection of scalars (depending on the parametrized type).
Result	query(String cypher, Map<String,?> parameters) 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.
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> objectType, String cypher, Map<String,?> parameters) Given a cypher statement this method will return a domain object that is hydrated to the default level or a scalar (depending on the parametrized type).

Method Detail

queryForObject

<T> T queryForObject(Class<T> objectType,
                   String cypher,
                   Map<String,?> parameters)

Given a cypher statement this method will return a domain object that is hydrated to the default level or a scalar (depending on the parametrized type).

Type Parameters:

T - A domain object or scalar.

Parameters:

objectType - The type that should be returned from the query.

cypher - The parametrizable cypher to execute.

parameters - Any scalar parameters to attach to the cypher.

Returns:

An instance of the objectType that matches the given cypher and parameters. Null if no object is matched

Throws:

RuntimeException - If more than one object is found.

query

<T> Iterable<T> query(Class<T> objectType,
                    String cypher,
                    Map<String,?> parameters)

Given a cypher statement this method will return a collection of domain objects that is hydrated to the default level or a collection of scalars (depending on the parametrized type).

Type Parameters:

T - A domain object or scalar.

Parameters:

objectType - The type that should be returned from the query.

cypher - The parametrizable cypher to execute.

parameters - Any parameters to attach to the cypher.

Returns:

A collection of domain objects or scalars as prescribed by the parametrized type.

query

Result query(String cypher,
           Map<String,?> parameters)

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.

Returns:

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

query

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.

countEntitiesOfType

long countEntitiesOfType(Class<?> entity)

Counts all the node entities of the specified type.

Parameters:

entity - The Class denoting the type of entity to count

Returns:

The number of entities in the database of the given type