org.neo4j.ogm.session

Class SessionFactory

java.lang.Object

org.neo4j.ogm.session.SessionFactory

public class SessionFactory
extends Object

This is the main initialization point of OGM. Used to create Session instances for interacting with Neo4j. In a typical scenario one instance of SessionFactory is created, shared across whole application.

Author:

Vince Bickers, Luanne Misquitta, Mark Angrish, Frantisek Hartman

Constructor Summary

Constructors

Constructor and Description
SessionFactory(Configuration configuration, String... packages) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages, and also sets the baseConfiguration to be used.
SessionFactory(Driver driver, String... packages) Create a session factory with given driver Use this constructor when you need to provide fully customized driver.
SessionFactory(String... packages) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages and starts up the Neo4j database in embedded mode.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this session factory Also closes any underlying resources, like driver etc.
void	deregister(EventListener eventListener) Removes the the specified listener from this SessionFactory.
Driver	getDriver() Returns driver used by this SessionFactory
LoadStrategy	getLoadStrategy() Returns current load strategy
MetaData	metaData() Retrieves the meta-data that was built up when this SessionFactory was constructed.
Session	openSession() Opens a new Neo4j mapping Session using the Driver specified in the OGM baseConfiguration The driver should be configured to connect to the database using the appropriate DriverConfig
void	register(EventListener eventListener) Registers the specified listener on all Session events generated from this SessionFactory.
void	register(IdStrategy strategy) Register an instance of IdStrategy This instance will be used for generation of ids annotated with @Id @GeneratedValue(strategy=SomeClass.class)
void	setLoadStrategy(LoadStrategy loadStrategy) Sets the LoadStrategy Will be used for all queries on subsequently created sessions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionFactory

public SessionFactory(String... packages)

Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages and starts up the Neo4j database in embedded mode. If the embedded driver is not available this method will throw a Exception.

The package names passed to this constructor should not contain wildcards or trailing full stops, for example, "org.springframework.data.neo4j.example.domain" would be fine. The default behaviour is for sub-packages to be scanned and you can also specify fully-qualified class names if you want to cherry pick particular classes.

Indexes will also be checked or built if configured.

Parameters:

packages - The packages to scan for domain objects

SessionFactory

public SessionFactory(Configuration configuration,
                      String... packages)

Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages, and also sets the baseConfiguration to be used.

The package names passed to this constructor should not contain wildcards or trailing full stops, for example, "org.springframework.data.neo4j.example.domain" would be fine. The default behaviour is for sub-packages to be scanned and you can also specify fully-qualified class names if you want to cherry pick particular classes.

Indexes will also be checked or built if configured.

Parameters:

configuration - The baseConfiguration to use

packages - The packages to scan for domain objects

SessionFactory

public SessionFactory(Driver driver,
                      String... packages)

Create a session factory with given driver Use this constructor when you need to provide fully customized driver.

Parameters:

driver - driver to be used with this SessionFactory

packages - The packages to scan for domain objects

Method Detail

metaData

public MetaData metaData()

Retrieves the meta-data that was built up when this SessionFactory was constructed.

Returns:

The underlying MetaData

openSession

public Session openSession()

Opens a new Neo4j mapping Session using the Driver specified in the OGM baseConfiguration The driver should be configured to connect to the database using the appropriate DriverConfig

Returns:

A new Session

register

public void register(EventListener eventListener)

Registers the specified listener on all Session events generated from this SessionFactory. Only Session instances created after this call are affected.

Parameters:

eventListener - The event listener to register.

deregister

public void deregister(EventListener eventListener)

Removes the the specified listener from this SessionFactory. Only Session instances created after this call are affected.

Parameters:

eventListener - The event listener to deregister.

getLoadStrategy

public LoadStrategy getLoadStrategy()

Returns current load strategy

Returns:

load strategy

setLoadStrategy

public void setLoadStrategy(LoadStrategy loadStrategy)

Sets the LoadStrategy Will be used for all queries on subsequently created sessions. This also can be set on individual Session instances.

Parameters:

loadStrategy - load strategy

getDriver

public Driver getDriver()

Returns driver used by this SessionFactory

Returns:

driver

close

public void close()

Closes this session factory Also closes any underlying resources, like driver etc.

register

public void register(IdStrategy strategy)

Register an instance of IdStrategy This instance will be used for generation of ids annotated with @Id @GeneratedValue(strategy=SomeClass.class)

Parameters:

strategy - IdStrategy to use