org.neo4j.ogm.session

Class SessionFactory

java.lang.Object

org.neo4j.ogm.session.SessionFactory

public class SessionFactory
extends Object

Used to create Session instances for interacting with Neo4j.

Author:

Vince Bickers, Luanne Misquitta, Mark Angrish

Constructor Summary

Constructors

Constructor and Description
SessionFactory(Class... classes) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object classes.
SessionFactory(Configuration configuration, Class... classes) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object classes, and also sets the configuration to be used.
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 configuration to be used.
SessionFactory(String... packages) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	deregister(EventListener eventListener) Asynchronously removes the the specified listener from this SessionFactory.
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 configuration The driver should be configured to connect to the database using the appropriate DriverConfig
void	register(EventListener eventListener) Asynchronously registers the specified listener on all Session events generated from this SessionFactory.

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.

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(Class... classes)

Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object classes.

This will only load the classes explicitly listed. No other classes will be loaded.

Indexes will also be checked or built if configured.

Parameters:

classes - The classes to load as 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 configuration 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 configuration to use

packages - The packages to scan for domain objects

SessionFactory

public SessionFactory(Configuration configuration,
              Class... classes)

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

This will only load the classes explicitly listed. No other classes will be loaded.

Indexes will also be checked or built if configured.

Parameters:

configuration - The configuration to use

classes - The classes to load as 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 configuration The driver should be configured to connect to the database using the appropriate DriverConfig

Returns:

A new Session

register

public void register(EventListener eventListener)

Asynchronously registers the specified listener on all Session events generated from this SessionFactory.

Parameters:

eventListener - The event listener to register.

deregister

public void deregister(EventListener eventListener)

Asynchronously removes the the specified listener from this SessionFactory.

Parameters:

eventListener - The event listener to deregister.

close

public void close()