org.neo4j.ogm.session

Class Neo4jSession

java.lang.Object

org.neo4j.ogm.session.Neo4jSession

All Implemented Interfaces:

Capability.Delete, Capability.ExecuteQueries, Capability.ExecuteStatements, Capability.GraphId, Capability.LoadByIds, Capability.LoadByInstances, Capability.LoadByType, Capability.LoadOne, Capability.Save, Capability.Transactions, Session

public class Neo4jSession
extends Object
implements Session

Author:

Vince Bickers, Luanne Misquitta

Constructor Summary

Constructors

Constructor and Description
Neo4jSession(MetaData metaData, String url, org.apache.http.impl.client.CloseableHttpClient client, com.fasterxml.jackson.databind.ObjectMapper mapper)
Neo4jSession(MetaData metaData, String url, org.apache.http.impl.client.CloseableHttpClient client, com.fasterxml.jackson.databind.ObjectMapper mapper, UsernamePasswordCredentials credentials)

Method Summary

Methods

Modifier and Type	Method and Description
Transaction	beginTransaction() Begin a new transaction.
void	clear()
MappingContext	context()
long	countEntitiesOfType(Class<?> entity) Counts all the node entities of the specified type.
void	debug(String msg)
<T> void	delete(T object)
<T> void	deleteAll(Class<T> type)
<T> T	doInTransaction(GraphCallback<T> graphCallback) Applies the given GraphCallback in the scope of this Session, giving fine-grained control over behaviour.
Transaction	ensureTransaction()
String	entityType(String name)
void	error(String msg)
QueryStatistics	execute(String statement)
QueryStatistics	execute(String cypher, Map<String,Object> parameters) This method allows a cypher statement with a modification statement to be executed.
Transaction	getTransaction() Get the existing transaction if available
void	info(String msg)
<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, Collection<Long> ids, Pagination paging)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, Pagination paging, int depth)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, SortOrder sortOrder)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, SortOrder sortOrder, int depth)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, SortOrder sortOrder, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, Collection<Long> ids, SortOrder sortOrder, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filter filter)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filters filters)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, SortOrder sortOrder)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, SortOrder sortOrder, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, SortOrder sortOrder, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, Filter filter, SortOrder sortOrder, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, SortOrder sortOrder)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, SortOrder sortOrder, int depth)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, SortOrder sortOrder, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, Filters filters, SortOrder sortOrder, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Class<T> type, int depth)
<T> Collection<T>	loadAll(Class<T> type, Pagination paging)
<T> Collection<T>	loadAll(Class<T> type, Pagination paging, int depth)
<T> Collection<T>	loadAll(Class<T> type, SortOrder sortOrder)
<T> Collection<T>	loadAll(Class<T> type, SortOrder sortOrder, int depth)
<T> Collection<T>	loadAll(Class<T> type, SortOrder sortOrder, Pagination pagination)
<T> Collection<T>	loadAll(Class<T> type, SortOrder sortOrder, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Collection<T> objects)
<T> Collection<T>	loadAll(Collection<T> objects, int depth)
<T> Collection<T>	loadAll(Collection<T> objects, Pagination pagination)
<T> Collection<T>	loadAll(Collection<T> objects, Pagination pagination, int depth)
<T> Collection<T>	loadAll(Collection<T> objects, SortOrder sortOrder)
<T> Collection<T>	loadAll(Collection<T> objects, SortOrder sortOrder, int depth)
<T> Collection<T>	loadAll(Collection<T> objects, SortOrder sortOrder, Pagination pagination)
<T> Collection<T>	loadAll(Collection<T> objects, SortOrder sortOrder, Pagination pagination, int depth)
com.fasterxml.jackson.databind.ObjectMapper	mapper()
MetaData	metaData()
void	purgeDatabase()
<T> Iterable<T>	query(Class<T> type, 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> type, 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).
QueryStatements	queryStatementsFor(Class type)
RequestHandler	requestHandler()
Long	resolveGraphIdFor(Object possibleEntity) Resolve the graph id for a possible entity
ResponseHandler	responseHandler()
<T> void	save(T object)
<T> void	save(T object, int depth)
void	setRequest(Neo4jRequest<String> neo4jRequest)
TransactionManager	transactionManager()
void	warn(String msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

Neo4jSession

public Neo4jSession(MetaData metaData,
            String url,
            org.apache.http.impl.client.CloseableHttpClient client,
            com.fasterxml.jackson.databind.ObjectMapper mapper)

Neo4jSession

public Neo4jSession(MetaData metaData,
            String url,
            org.apache.http.impl.client.CloseableHttpClient client,
            com.fasterxml.jackson.databind.ObjectMapper mapper,
            UsernamePasswordCredentials credentials)

Method Detail

load

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

Specified by:

load in interface Capability.LoadOne

load

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

Specified by:

load in interface Capability.LoadOne

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Pagination paging)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        SortOrder sortOrder)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        SortOrder sortOrder,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        SortOrder sortOrder,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        SortOrder sortOrder)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        SortOrder sortOrder,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        SortOrder sortOrder,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filter filter,
                        SortOrder sortOrder,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        SortOrder sortOrder)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        SortOrder sortOrder,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        SortOrder sortOrder,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Filters filters,
                        SortOrder sortOrder,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByType

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Collection<Long> ids,
                        SortOrder sortOrder,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T> Collection<T> loadAll(Class<T> type,
                        Collection<Long> ids,
                        SortOrder sortOrder,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

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

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        SortOrder sortOrder)

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        SortOrder sortOrder,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        SortOrder sortOrder,
                        Pagination pagination)

Specified by:

loadAll in interface Capability.LoadByInstances

loadAll

public <T> Collection<T> loadAll(Collection<T> objects,
                        SortOrder sortOrder,
                        Pagination pagination,
                        int depth)

Specified by:

loadAll in interface Capability.LoadByInstances

queryForObject

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

Description copied from interface: Capability.ExecuteQueries

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).

Specified by:

queryForObject in interface Capability.ExecuteQueries

Type Parameters:

T - A domain object or scalar.

Parameters:

type - 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

query

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

Description copied from interface: Capability.ExecuteQueries

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?

Specified by:

query in interface Capability.ExecuteQueries

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

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

Description copied from interface: Capability.ExecuteQueries

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?

Specified by:

query in interface Capability.ExecuteQueries

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.

query

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

Description copied from interface: Capability.ExecuteQueries

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).

Specified by:

query in interface Capability.ExecuteQueries

Type Parameters:

T - A domain object or scalar.

Parameters:

type - 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.

countEntitiesOfType

public long countEntitiesOfType(Class<?> entity)

Description copied from interface: Capability.ExecuteQueries

Counts all the node entities of the specified type.

Specified by:

countEntitiesOfType in interface Capability.ExecuteQueries

Parameters:

entity - The Class denoting the type of entity to count

Returns:

The number of entities in the database of the given type

purgeDatabase

public void purgeDatabase()

Specified by:

purgeDatabase in interface Capability.Delete

clear

public void clear()

Specified by:

clear in interface Capability.Delete

delete

public <T> void delete(T object)

Specified by:

delete in interface Capability.Delete

deleteAll

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

Specified by:

deleteAll in interface Capability.Delete

save

public <T> void save(T object)

Specified by:

save in interface Capability.Save

save

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

Specified by:

save in interface Capability.Save

execute

public QueryStatistics execute(String cypher,
                      Map<String,Object> parameters)

Description copied from interface: Capability.ExecuteStatements

This method allows a cypher statement with a modification statement to be executed.

Parameters may be scalars or domain objects themselves.

Specified by:

execute in interface Capability.ExecuteStatements

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.

execute

public QueryStatistics execute(String statement)

Specified by:

execute in interface Capability.ExecuteStatements

beginTransaction

public Transaction beginTransaction()

Description copied from interface: Capability.Transactions

Begin a new transaction. If an existing transaction already exists, users must decide whether to commit or rollback. Only one transaction can be bound to a thread at any time, so active transactions that have not been closed but are no longer bound to the thread must be handled by client code.

Specified by:

beginTransaction in interface Capability.Transactions

Returns:

a new active Transaction

doInTransaction

public <T> T doInTransaction(GraphCallback<T> graphCallback)

Description copied from interface: Capability.Transactions

Applies the given GraphCallback in the scope of this Session, giving fine-grained control over behaviour.

Specified by:

doInTransaction in interface Capability.Transactions

Parameters:

graphCallback - The GraphCallback to execute

Returns:

The result of calling the given GraphCallback

getTransaction

public Transaction getTransaction()

Description copied from interface: Capability.Transactions

Get the existing transaction if available

Specified by:

getTransaction in interface Capability.Transactions

Returns:

an active Transaction, or null if none exists

resolveGraphIdFor

public Long resolveGraphIdFor(Object possibleEntity)

Description copied from interface: Capability.GraphId

Resolve the graph id for a possible entity

Specified by:

resolveGraphIdFor in interface Capability.GraphId

Parameters:

possibleEntity - the possible entity

Returns:

the value of the Capability.GraphId or null if either the object is not an entity or the id is null.

queryStatementsFor

public QueryStatements queryStatementsFor(Class type)

entityType

public String entityType(String name)

context

public MappingContext context()

metaData

public MetaData metaData()

mapper

public com.fasterxml.jackson.databind.ObjectMapper mapper()

setRequest

public void setRequest(Neo4jRequest<String> neo4jRequest)

requestHandler

public RequestHandler requestHandler()

ensureTransaction

public Transaction ensureTransaction()

responseHandler

public ResponseHandler responseHandler()

transactionManager

public TransactionManager transactionManager()

info

public void info(String msg)

warn

public void warn(String msg)

debug

public void debug(String msg)

error

public void error(String msg)