org.neo4j.kernel

Class InternalAbstractGraphDatabase

java.lang.Object

org.neo4j.kernel.AbstractGraphDatabase

org.neo4j.kernel.InternalAbstractGraphDatabase

All Implemented Interfaces:

GraphDatabaseService, GraphDatabaseAPI

Direct Known Subclasses:

EmbeddedGraphDatabase, EmbeddedReadOnlyGraphDatabase, org.neo4j.kernel.ha.HighlyAvailableGraphDatabase

public abstract class InternalAbstractGraphDatabase
extends AbstractGraphDatabase
implements GraphDatabaseService, GraphDatabaseAPI

Base implementation of GraphDatabaseService. Responsible for creating services, handling dependencies between them, and lifecycle management of these.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalAbstractGraphDatabase.Configuration

Method Summary

Methods

Modifier and Type	Method and Description
Transaction	beginTx() Starts a new transaction and associates it with the current thread.
Node	createNode() Creates a new node.
Node	createNode(Label... labels) Creates a new node and adds the provided labels to it.
boolean	equals(Object o)
ResourceIterable<Node>	findNodesByLabelAndProperty(Label myLabel, String key, Object value) Returns all nodes having the label, and the wanted property value.
Iterable<Node>	getAllNodes() Returns all nodes in the graph.
org.neo4j.kernel.configuration.Config	getConfig()
DependencyResolver	getDependencyResolver()
org.neo4j.kernel.info.DiagnosticsManager	getDiagnosticsManager()
org.neo4j.kernel.guard.Guard	getGuard()
IdGeneratorFactory	getIdGeneratorFactory()
KernelData	getKernelData()
org.neo4j.kernel.impl.core.KernelPanicEventGenerator	getKernelPanicGenerator()
org.neo4j.kernel.impl.transaction.LockManager	getLockManager()
org.neo4j.kernel.impl.util.StringLogger	getMessageLog()
Node	getNodeById(long id) Looks up a node by id.
org.neo4j.kernel.impl.core.NodeManager	getNodeManager()
org.neo4j.kernel.impl.persistence.PersistenceSource	getPersistenceSource()
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.
Iterable<RelationshipType>	getRelationshipTypes() Returns all relationship types currently in the underlying store.
org.neo4j.kernel.impl.core.RelationshipTypeTokenHolder	getRelationshipTypeTokenHolder()
String	getStoreDir()
org.neo4j.kernel.impl.nioneo.store.StoreId	getStoreId()
org.neo4j.kernel.impl.transaction.xaframework.TxIdGenerator	getTxIdGenerator()
TransactionManager	getTxManager()
org.neo4j.kernel.impl.transaction.XaDataSourceManager	getXaDataSourceManager()
int	hashCode()
IndexManager	index() Returns the IndexManager paired with this graph database service and is the entry point for managing indexes coupled with this database.
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.
Schema	schema() Returns the schema manager where all things related to schema, for example constraints and indexing on labels.
void	shutdown() Shuts down Neo4j.
String	toString()
boolean	transactionRunning()
TransactionBuilder	tx()
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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDependencyResolver

public DependencyResolver getDependencyResolver()

Specified by:

getDependencyResolver in interface GraphDatabaseAPI

shutdown

public void shutdown()

Description copied from interface: GraphDatabaseService

Shuts down Neo4j. After this method has been invoked, it's invalid to invoke any methods in the Neo4j API and all references to this instance of GraphDatabaseService should be discarded.

Specified by:

shutdown in interface GraphDatabaseService

getStoreDir

public final String getStoreDir()

Specified by:

getStoreDir in interface GraphDatabaseAPI

getStoreId

public org.neo4j.kernel.impl.nioneo.store.StoreId getStoreId()

Specified by:

getStoreId in interface GraphDatabaseAPI

beginTx

public Transaction beginTx()

Description copied from interface: GraphDatabaseService

Starts a new transaction and associates it with the current thread.

All database operations that modify the graph must be wrapped in a transaction.

If you attempt to modify the graph outside of a transaction, those operations will throw NotInTransactionException.

Transactions are not required for read-only operations, however it is recommended to enclose read only operations in a transaction, because the database can be more intelligent about managing resources. In particular, returned ResourceIterables will be automatically released at the end of a transaction.

If you execute read-only operations outside of a transaction, please take care that any returned ResourceIterables are closed correctly to avoid potential blocking of write operations.

Specified by:

beginTx in interface GraphDatabaseService

Returns:

a new transaction instance

transactionRunning

public boolean transactionRunning()

Specified by:

transactionRunning in class AbstractGraphDatabase

toString

public String toString()

Overrides:

toString in class Object

getAllNodes

public Iterable<Node> getAllNodes()

Description copied from interface: GraphDatabaseService

Returns all nodes in the graph.

Specified by:

getAllNodes in interface GraphDatabaseService

Returns:

all nodes in the graph.

getRelationshipTypes

public Iterable<RelationshipType> getRelationshipTypes()

Description copied from interface: GraphDatabaseService

Returns all relationship types currently in the underlying store. Relationship types are added to the underlying store the first time they are used in a successfully commited node.createRelationshipTo(...). Note that this method is guaranteed to return all known relationship types, but it does not guarantee that it won't return more than that (e.g. it can return "historic" relationship types that no longer have any relationships in the node space).

Specified by:

getRelationshipTypes in interface GraphDatabaseService

Returns:

all relationship types in the underlying store

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.

Specified by:

registerKernelEventHandler in interface GraphDatabaseService

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.

Specified by:

registerTransactionEventHandler in interface GraphDatabaseService

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.

Specified by:

unregisterKernelEventHandler in interface GraphDatabaseService

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.

Specified by:

unregisterTransactionEventHandler in interface GraphDatabaseService

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.

createNode

public Node createNode()

Description copied from interface: GraphDatabaseService

Creates a new node.

Specified by:

createNode in interface GraphDatabaseService

Returns:

the created node.

createNode

public Node createNode(Label... labels)

Description copied from interface: GraphDatabaseService

Creates a new node and adds the provided labels to it.

Specified by:

createNode in interface GraphDatabaseService

Parameters:

labels - labels to add to the created node.

Returns:

the created node.

getNodeById

public Node getNodeById(long id)

Description copied from interface: GraphDatabaseService

Looks up a node by id. Please note: Neo4j reuses its internal ids when nodes and relationships are deleted, which means it's bad practice to refer to them this way. Instead, use application generated ids.

Specified by:

getNodeById in interface GraphDatabaseService

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. Please note: Neo4j reuses its internal ids when nodes and relationships are deleted, which means it's bad practice to refer to them this way. Instead, use application generated ids.

Specified by:

getRelationshipById in interface GraphDatabaseService

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 graph.

Specified by:

getReferenceNode in interface GraphDatabaseService

Returns:

the reference node

tx

public TransactionBuilder tx()

Specified by:

tx in interface GraphDatabaseAPI

getGuard

public org.neo4j.kernel.guard.Guard getGuard()

Specified by:

getGuard in interface GraphDatabaseAPI

getKernelData

public KernelData getKernelData()

Specified by:

getKernelData in interface GraphDatabaseAPI

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.

Specified by:

index in interface GraphDatabaseService

Returns:

the IndexManager for this database.

schema

public Schema schema()

Description copied from interface: GraphDatabaseService

Returns the schema manager where all things related to schema, for example constraints and indexing on labels.

Specified by:

schema in interface GraphDatabaseService

Returns:

the schema manager for this database.

getConfig

public org.neo4j.kernel.configuration.Config getConfig()

getNodeManager

public org.neo4j.kernel.impl.core.NodeManager getNodeManager()

Specified by:

getNodeManager in interface GraphDatabaseAPI

getLockManager

public org.neo4j.kernel.impl.transaction.LockManager getLockManager()

Specified by:

getLockManager in interface GraphDatabaseAPI

getXaDataSourceManager

public org.neo4j.kernel.impl.transaction.XaDataSourceManager getXaDataSourceManager()

Specified by:

getXaDataSourceManager in interface GraphDatabaseAPI

getTxManager

public TransactionManager getTxManager()

Specified by:

getTxManager in interface GraphDatabaseAPI

getRelationshipTypeTokenHolder

public org.neo4j.kernel.impl.core.RelationshipTypeTokenHolder getRelationshipTypeTokenHolder()

Specified by:

getRelationshipTypeTokenHolder in interface GraphDatabaseAPI

getIdGeneratorFactory

public IdGeneratorFactory getIdGeneratorFactory()

Specified by:

getIdGeneratorFactory in interface GraphDatabaseAPI

getDiagnosticsManager

public org.neo4j.kernel.info.DiagnosticsManager getDiagnosticsManager()

Specified by:

getDiagnosticsManager in interface GraphDatabaseAPI

getPersistenceSource

public org.neo4j.kernel.impl.persistence.PersistenceSource getPersistenceSource()

Specified by:

getPersistenceSource in interface GraphDatabaseAPI

getMessageLog

public final org.neo4j.kernel.impl.util.StringLogger getMessageLog()

Specified by:

getMessageLog in interface GraphDatabaseAPI

getTxIdGenerator

public org.neo4j.kernel.impl.transaction.xaframework.TxIdGenerator getTxIdGenerator()

Specified by:

getTxIdGenerator in interface GraphDatabaseAPI

getKernelPanicGenerator

public org.neo4j.kernel.impl.core.KernelPanicEventGenerator getKernelPanicGenerator()

Specified by:

getKernelPanicGenerator in interface GraphDatabaseAPI

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

findNodesByLabelAndProperty

public ResourceIterable<Node> findNodesByLabelAndProperty(Label myLabel,
                                                 String key,
                                                 Object value)

Description copied from interface: GraphDatabaseService

Returns all nodes having the label, and the wanted property value. If an online index is found, it will be used to look up the requested nodes.

If no indexes exist for the label/property combination, the database will scan all labelled nodes looking for the property value. If you call this operation outside of a transaction, please take care that the returned ResourceIterable is closed correctly to avoid potential blocking of write operations.

Specified by:

findNodesByLabelAndProperty in interface GraphDatabaseService

Parameters:

myLabel - consider nodes with this label

key - required property key

value - required property value

Returns:

an iterable containing all matching nodes. See { @link ResourceIterable } for responsibilities.