org.neo4j.ogm.session

Class Neo4jSession

java.lang.Object

org.neo4j.ogm.session.Neo4jSession

All Implemented Interfaces:

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

public class Neo4jSession
extends Object
implements Session

Author:

Vince Bickers, Luanne Misquitta, Mihai Raulea, Mark Angrish

Constructor Summary

Constructors

Constructor and Description
Neo4jSession(MetaData metaData, Driver driver)
Neo4jSession(MetaData metaData, Driver driver, List<EventListener> eventListeners)

Method Summary

Methods

Modifier and Type	Method and Description
Transaction	beginTransaction() Begin a new READ_WRITE transaction.
Transaction	beginTransaction(Transaction.Type type) Begin a new transaction, passing in the required type (READ_ONLY, READ_WRITE).
void	clear()
MappingContext	context()
long	count(Class<?> clazz, Iterable<Filter> filters) Counts all the node entities of the specified type which match the filters supplied
long	countEntitiesOfType(Class<?> entity) Counts all the node entities of the specified type.
void	debug(String msg)
<T> Object	delete(Class<T> type, Iterable<Filter> filters, boolean listResults)
<T> void	delete(T object)
<T> void	deleteAll(Class<T> type)
boolean	detachNodeEntity(Long id)
boolean	detachRelationshipEntity(Long id)
boolean	dispose(EventListener eventListener)
<T> T	doInTransaction(GraphCallback<T> graphCallback) Deprecated.
String	entityType(String name)
boolean	eventsEnabled()
String	getLastBookmark() Retrieves the last bookmark used in this session when used in a Neo4j Causal Cluster.
Transaction	getTransaction() Get the existing transaction if available
void	info(String msg)
<T,ID extends Serializable> T	load(Class<T> type, ID id)
<T,ID extends Serializable> T	load(Class<T> type, ID id, int depth)
<T> Collection<T>	loadAll(Class<T> type)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, int depth)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, Pagination paging)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, Pagination paging, int depth)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, SortOrder sortOrder)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, SortOrder sortOrder, int depth)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> ids, SortOrder sortOrder, Pagination pagination)
<T,ID extends Serializable> Collection<T>	loadAll(Class<T> type, Collection<ID> 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)
MetaData	metaData()
void	notifyListeners(Event event)
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).
<T,ID extends Serializable> QueryStatements<ID>	queryStatementsFor(Class<T> type)
EventListener	register(EventListener eventListener)
Request	requestHandler()
Long	resolveGraphIdFor(Object possibleEntity) Resolve the graph id for a possible entity
void	resolvePropertyAnnotations(Class entityType, Iterable<Filter> filters)
void	resolvePropertyAnnotations(Class entityType, SortOrder sortOrder)
<T> void	save(T object)
<T> void	save(T object, int depth)
void	setDriver(Driver driver)
DefaultTransactionManager	transactionManager()
void	warn(String msg)
void	withBookmark(String bookmark) Sets the bookmark to use on this session.

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,
            Driver driver)

Neo4jSession

public Neo4jSession(MetaData metaData,
            Driver driver,
            List<EventListener> eventListeners)

Method Detail

register

public EventListener register(EventListener eventListener)

Specified by:

register in interface Observer

notifyListeners

public void notifyListeners(Event event)

Specified by:

notifyListeners in interface Observer

eventsEnabled

public boolean eventsEnabled()

Specified by:

eventsEnabled in interface Observer

dispose

public boolean dispose(EventListener eventListener)

Specified by:

dispose in interface Observer

load

public <T,ID extends Serializable> T load(Class<T> type,
                                 ID id)

Specified by:

load in interface Capability.LoadOne

load

public <T,ID extends Serializable> T load(Class<T> type,
                                 ID 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,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                Collection<ID> ids)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                Collection<ID> ids,
                                                int depth)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                Collection<ID> ids,
                                                SortOrder sortOrder)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                Collection<ID> ids,
                                                Pagination paging)

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

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

Specified by:

loadAll in interface Capability.LoadByIds

loadAll

public <T,ID extends Serializable> Collection<T> loadAll(Class<T> type,
                                                Collection<ID> 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 <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.

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.

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

count

public long count(Class<?> clazz,
         Iterable<Filter> filters)

Description copied from interface: Capability.ExecuteQueries

Counts all the node entities of the specified type which match the filters supplied

Specified by:

count in interface Capability.ExecuteQueries

Parameters:

clazz - The Class denoting the type of entity to count

filters - a collection of Filter objects used as additional parameters to the query

Returns:

The number of entities in the database of the given type matched by the given filters

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

delete

public <T> Object delete(Class<T> type,
                Iterable<Filter> filters,
                boolean listResults)

Specified by:

delete 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

beginTransaction

public Transaction beginTransaction()

Description copied from interface: Capability.Transactions

Begin a new READ_WRITE 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

beginTransaction

public Transaction beginTransaction(Transaction.Type type)

Description copied from interface: Capability.Transactions

Begin a new transaction, passing in the required type (READ_ONLY, READ_WRITE). 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

Parameters:

type - the Transaction.Type required for this transaction

Returns:

a new active Transaction

doInTransaction

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

Deprecated.

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

Type Parameters:

T - The type of object returned from applying this callback

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.

detachNodeEntity

public boolean detachNodeEntity(Long id)

Specified by:

detachNodeEntity in interface Capability.GraphId

detachRelationshipEntity

public boolean detachRelationshipEntity(Long id)

Specified by:

detachRelationshipEntity in interface Capability.GraphId

queryStatementsFor

public <T,ID extends Serializable> QueryStatements<ID> queryStatementsFor(Class<T> type)

entityType

public String entityType(String name)

context

public MappingContext context()

metaData

public MetaData metaData()

setDriver

public void setDriver(Driver driver)

requestHandler

public Request requestHandler()

transactionManager

public DefaultTransactionManager transactionManager()

info

public void info(String msg)

warn

public void warn(String msg)

debug

public void debug(String msg)

resolvePropertyAnnotations

public void resolvePropertyAnnotations(Class entityType,
                              Iterable<Filter> filters)

resolvePropertyAnnotations

public void resolvePropertyAnnotations(Class entityType,
                              SortOrder sortOrder)

getLastBookmark

public String getLastBookmark()

Description copied from interface: Session

Retrieves the last bookmark used in this session when used in a Neo4j Causal Cluster. This bookmark can be used to ensure the cluster is consistent before performing a read/write.

Specified by:

getLastBookmark in interface Session

Returns:

The last used bookmark String on this session.

withBookmark

public void withBookmark(String bookmark)

Description copied from interface: Session

Sets the bookmark to use on this session. Useful when resuming a user session with a causal cluster.

Specified by:

withBookmark in interface Session

Parameters:

bookmark - The last used bookmark String that this session should start from.