org.neo4j.kernel
Class EmbeddedGraphDatabase

java.lang.Object
  org.neo4j.kernel.AbstractGraphDatabase
      org.neo4j.kernel.EmbeddedGraphDatabase

All Implemented Interfaces:

GraphDatabaseService

public final class EmbeddedGraphDatabase
extends AbstractGraphDatabase

An implementation of GraphDatabaseService that is used to embed Neo4j in an application. You typically instantiate it by invoking the single argument constructor that takes a path to a directory where Neo4j will store its data files, as such:

 
 GraphDatabaseService graphDb = new EmbeddedGraphDatabase( "var/graphdb" );
 // ... use Neo4j
 graphDb.shutdown();
 
 

For more information, see GraphDatabaseService.

Constructor Summary

EmbeddedGraphDatabase(String storeDir)
Creates an embedded GraphDatabaseService with a store located in storeDir, which will be created if it doesn't already exist.

EmbeddedGraphDatabase(String storeDir, Map<String,String> params)
A non-standard way of creating an embedded GraphDatabaseService with a set of configuration parameters.

Method Summary

protected void	close()
Node	createNode() Creates a new node.
Config	getConfig() Returns a non-standard configuration object.
KernelData	getKernelData()
<T> Collection<T>	getManagementBeans(Class<T> type)
Node	getNodeById(long id) Looks up a node by id.
Node	getReferenceNode() Returns the reference node, which is a "starting point" in the node space.
Relationship	getRelationshipById(long id) Looks up a relationship by id.
IndexManager	index() Returns the IndexManager paired with this graph database service and is the entry point for managing indexes coupled with this database.
static Map<String,String>	loadConfigurations(String file) A non-standard convenience method that loads a standard property file and converts it into a generic Map.
KernelEventHandler	registerKernelEventHandler(KernelEventHandler handler) Registers handler as a handler for kernel events which are generated from different places in the lifecycle of the kernel.
<T> TransactionEventHandler<T>	registerTransactionEventHandler(TransactionEventHandler<T> handler) Registers handler as a handler for transaction events which are generated from different places in the lifecycle of each transaction.
TransactionBuilder	tx() Returns a new builder where some aspects of the behavior can be configured.
KernelEventHandler	unregisterKernelEventHandler(KernelEventHandler handler) Unregisters handler from the list of kernel event handlers.
<T> TransactionEventHandler<T>	unregisterTransactionEventHandler(TransactionEventHandler<T> handler) Unregisters handler from the list of transaction event handlers.

Methods inherited from class org.neo4j.kernel.AbstractGraphDatabase

beginTx, createStringLogger, getAllNodes, getManagementBean, getMessageLog, getRelationshipTypes, getSingleManagementBean, getStoreDir, isEphemeral, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedGraphDatabase

public EmbeddedGraphDatabase(String storeDir)

Creates an embedded GraphDatabaseService with a store located in storeDir, which will be created if it doesn't already exist.

Parameters:

storeDir - the store directory for the Neo4j store files

EmbeddedGraphDatabase

public EmbeddedGraphDatabase(String storeDir,
                             Map<String,String> params)

A non-standard way of creating an embedded GraphDatabaseService with a set of configuration parameters.

Creates an embedded GraphDatabaseService with a store located in storeDir, which will be created if it doesn't already exist.

Parameters:

storeDir - the store directory for the db files

params - configuration parameters

Method Detail

loadConfigurations

public static Map<String,String> loadConfigurations(String file)

A non-standard convenience method that loads a standard property file and converts it into a generic Map. Will most likely be removed in future releases.

Parameters:

file - the property file to load

Returns:

a map containing the properties from the file

Throws:

IllegalArgumentException - if file does not exist

createNode

public Node createNode()

Description copied from interface: GraphDatabaseService

Creates a new node.

Returns:

the created node.

getNodeById

public Node getNodeById(long id)

Description copied from interface: GraphDatabaseService

Looks up a node by id.

Parameters:

id - the id of the node

Returns:

the node with id id if found

getRelationshipById

public Relationship getRelationshipById(long id)

Description copied from interface: GraphDatabaseService

Looks up a relationship by id.

Parameters:

id - the id of the relationship

Returns:

the relationship with id id if found

getReferenceNode

public Node getReferenceNode()

Description copied from interface: GraphDatabaseService

Returns the reference node, which is a "starting point" in the node space. Usually, a client attaches relationships to this node that leads into various parts of the node space. For more information about common node space organizational patterns, see the design guide at wiki.neo4j.org/content/Design_Guide.

Returns:

the reference node

close

protected void close()

Specified by:

close in class AbstractGraphDatabase

tx

public TransactionBuilder tx()

Description copied from class: AbstractGraphDatabase

Returns a new builder where some aspects of the behavior can be configured. The transaction will ultimately begin when calling TransactionBuilder.begin().

Specified by:

tx in class AbstractGraphDatabase

Returns:

a builder for configuring transaction behavior and ultimately begin a transaction.

getConfig

public Config getConfig()

Returns a non-standard configuration object. Will most likely be removed in future releases.

Specified by:

getConfig in class AbstractGraphDatabase

Returns:

a configuration object

getManagementBeans

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

Specified by:

getManagementBeans in class AbstractGraphDatabase

getKernelData

public KernelData getKernelData()

Specified by:

getKernelData in class AbstractGraphDatabase

registerKernelEventHandler

public KernelEventHandler registerKernelEventHandler(KernelEventHandler handler)

Description copied from interface: GraphDatabaseService

Registers handler as a handler for kernel events which are generated from different places in the lifecycle of the kernel. To guarantee proper behaviour the handler should be registered right after the graph database has been started. If the specified handler instance has already been registered this method will do nothing.

Parameters:

handler - the handler to receive events about different states in the kernel lifecycle.

Returns:

the handler passed in as the argument.

registerTransactionEventHandler

public <T> TransactionEventHandler<T> registerTransactionEventHandler(TransactionEventHandler<T> handler)

Description copied from interface: GraphDatabaseService

Registers handler as a handler for transaction events which are generated from different places in the lifecycle of each transaction. To guarantee that the handler gets all events properly it shouldn't be registered when the application is running (i.e. in the middle of one or more transactions). If the specified handler instance has already been registered this method will do nothing.

Type Parameters:

T - the type of state object used in the handler, see more documentation about it at TransactionEventHandler.

Parameters:

handler - the handler to receive events about different states in transaction lifecycles.

Returns:

the handler passed in as the argument.

unregisterKernelEventHandler

public KernelEventHandler unregisterKernelEventHandler(KernelEventHandler handler)

Description copied from interface: GraphDatabaseService

Unregisters handler from the list of kernel event handlers. If handler hasn't been registered with GraphDatabaseService.registerKernelEventHandler(KernelEventHandler) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the handler will no longer receive any kernel events.

Parameters:

handler - the handler to receive events about different states in the kernel lifecycle.

Returns:

the handler passed in as the argument.

unregisterTransactionEventHandler

public <T> TransactionEventHandler<T> unregisterTransactionEventHandler(TransactionEventHandler<T> handler)

Description copied from interface: GraphDatabaseService

Unregisters handler from the list of transaction event handlers. If handler hasn't been registered with GraphDatabaseService.registerTransactionEventHandler(TransactionEventHandler) prior to calling this method an IllegalStateException will be thrown. After a successful call to this method the handler will no longer receive any transaction events.

Type Parameters:

T - the type of state object used in the handler, see more documentation about it at TransactionEventHandler.

Parameters:

handler - the handler to receive events about different states in transaction lifecycles.

Returns:

the handler passed in as the argument.

index

public IndexManager index()

Description copied from interface: GraphDatabaseService

Returns the IndexManager paired with this graph database service and is the entry point for managing indexes coupled with this database.

Returns:

the IndexManager for this database.