org.neo4j.ogm.session

Interface Session

All Known Implementing Classes:

Neo4jSession

public interface Session

Author:

Vince Bickers

Method Summary

Modifier and Type	Method and Description
Transaction	beginTransaction()
void	clear()
long	countEntitiesOfType(Class<?> entity) Counts all the node entities of the specified type.
<T> void	delete(T object)
<T> void	deleteAll(Class<T> type)
void	execute(String jsonStatements)
void	execute(String cypher, Map<String,Object> parameters) This method allows a cypher statement with a modification statement to be executed.
<T> T	load(Class<T> type, Long id)
<T> T	load(Class<T> type, Long id, int depth)
<T> Collection<T>	loadAll(Class<T> type)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, int depth)
<T> Collection<T>	loadAll(Class<T> type, int depth)
<T> Collection<T>	loadAll(Collection<T> objects)
<T> Collection<T>	loadAll(Collection<T> objects, int depth)
<T> Collection<T>	loadByProperty(Class<T> type, Property<String,Object> property)
<T> Collection<T>	loadByProperty(Class<T> type, Property<String,Object> property, int depth)
void	purgeDatabase()
<T> Iterable<T>	query(Class<T> objectType, String cypher, Map<String,?> parameters) Given a non modifying cypher statement this method will return a collection of domain objects that is hydrated to the level specified in the given cypher query or a collection of scalars (depending on the parametrized type).
Iterable<Map<String,Object>>	query(String cypher, Map<String,?> parameters) Given a non modifying cypher statement this method will return a collection of Map's which represent Neo4j objects as properties.
<T> T	queryForObject(Class<T> objectType, String cypher, Map<String,?> parameters) Given a non modifying cypher statement this method will return a domain object that is hydrated to the level specified in the given cypher query or a scalar (depending on the parametrized type).
<T> void	save(T object)
<T> void	save(T object, int depth)

Method Detail

load

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

load

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

loadAll

<T> Collection<T> loadAll(Class<T> type,
                          Collection<Long> ids)

loadAll

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

loadAll

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

loadAll

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

loadAll

<T> Collection<T> loadAll(Collection<T> objects)

loadAll

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

loadByProperty

<T> Collection<T> loadByProperty(Class<T> type,
                                 Property<String,Object> property)

loadByProperty

<T> Collection<T> loadByProperty(Class<T> type,
                                 Property<String,Object> property,
                                 int depth)

execute

void execute(String jsonStatements)

purgeDatabase

void purgeDatabase()

clear

void clear()

save

<T> void save(T object)

save

<T> void save(T object,
              int depth)

delete

<T> void delete(T object)

deleteAll

<T> void deleteAll(Class<T> type)

beginTransaction

Transaction beginTransaction()

queryForObject

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

Given a non modifying cypher statement this method will return a domain object that is hydrated to the level specified in the given cypher query 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 non modifying cypher statement this method will return a collection of domain objects that is hydrated to the level specified in the given cypher query 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

Iterable<Map<String,Object>> query(String cypher,
                                   Map<String,?> parameters)

Given a non modifying cypher statement this method will return a collection of Map's which represent Neo4j objects as properties. Each element is a map which you can access by the name of the returned field TODO: Decide if we want to keep this behaviour? 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:

An Iterable of Maps with each entry representing a neo4j object's properties.

execute

void execute(String cypher,
             Map<String,Object> parameters)

This method 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.

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