org.neo4j.ogm.service

Class Components

java.lang.Object

org.neo4j.ogm.service.Components

public class Components
extends Object

This class is responsible for ensuring that the various pluggable components required by the OGM can be loaded. The Components class can be explicitly configured via an Configuration instance. If no explicit configuration is supplied, the class will attempt to auto-configure. Auto-configuration is accomplished using a properties file. By default, this file is called "ogm.properties" and it must be available on the class path. You can supply a different configuration properties file, by specifying a system property "ogm.properties" that refers to the configuration file you want to use. Your alternative configuration file must be on the class path. The properties file should contain the desired configuration values for each of the various components - Driver, Compiler, etc. Please refer to the relevant configuration for each of these.

Author:

vince

Method Summary

Methods

Modifier and Type	Method and Description
static void	autoConfigure() The OGM Components can be auto-configured from a properties file, "ogm.properties", or a similar configuration file, specified by a system property or environment variable called "ogm.properties".
static AutoIndexMode	autoIndexMode() Return the AutoIndexMode from the AutoIndexConfiguration
static Compiler	compiler() Returns a new instance of the compiler
static void	configure(Configuration configuration) Configure the OGM from a pre-built Configuration class
static void	configure(String configurationFileName) Configure the OGM from the specified config file
static void	destroy() Releases any current driver resources and clears the current configuration
static Driver	driver() Returns the current OGM Driver Normally only one instance of the driver exists for the lifetime of the application You cannot use this method to find out if a driver is initialised because it will attempt to initialise the driver if it is not.
static Configuration	getConfiguration() There is a single configuration object, which should never be null, associated with the Components class You can update this configuration in-situ, or you can replace the configuration with another.
static double	neo4jVersion() Gets the neo4j.version from the current configuration
static void	setDriver(Driver driver) Sets a new Driver to be used by the OGM.

Methods inherited from class java.lang.Object

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

Method Detail

configure

public static void configure(Configuration configuration)

Configure the OGM from a pre-built Configuration class

Parameters:

configuration - The configuration to use

configure

public static void configure(String configurationFileName)

Configure the OGM from the specified config file

Parameters:

configurationFileName - The config file to use

driver

public static Driver driver()

Returns the current OGM Driver Normally only one instance of the driver exists for the lifetime of the application You cannot use this method to find out if a driver is initialised because it will attempt to initialise the driver if it is not.

Returns:

an instance of the Driver to be used by the OGM

compiler

public static Compiler compiler()

Returns a new instance of the compiler

Returns:

an instance of the Compiler to be used by the OGM

autoConfigure

public static void autoConfigure()

The OGM Components can be auto-configured from a properties file, "ogm.properties", or a similar configuration file, specified by a system property or environment variable called "ogm.properties". If an auto-configure properties file is not available by any of these means, the Components class should be configured by passing in a Configuration object to the configure method, or an explicit configuration file name

setDriver

public static void setDriver(Driver driver)

Sets a new Driver to be used by the OGM. If a different driver is in use, it will be closed first. In addition, the Configuration is updated to reflect the correct classname for the new driver.

Parameters:

driver - an instance of Driver to be used by the OGM.

neo4jVersion

public static double neo4jVersion()

Gets the neo4j.version from the current configuration

Returns:

the major.minor part of the neo4.version property string, as a double, or 9.9 if not configured

destroy

public static void destroy()

Releases any current driver resources and clears the current configuration

autoIndexMode

public static AutoIndexMode autoIndexMode()

Return the AutoIndexMode from the AutoIndexConfiguration

Returns:

the configured autoIndexMode or AutoIndexMode.NONE if not configured

getConfiguration

public static Configuration getConfiguration()

There is a single configuration object, which should never be null, associated with the Components class You can update this configuration in-situ, or you can replace the configuration with another.

Returns:

the current Configuration object