|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.neo4j.api.core.EmbeddedNeo
public final class EmbeddedNeo
An implementation of NeoService
that is used to embed Neo in an
application. You typically instantiate it by invoking the
single argument constructor
that takes a path to
a directory where Neo will store its data files, as such:
For more information, see
NeoService neo = new EmbeddedNeo( "var/neo" );
// ... use neo
neo.shutdown();
NeoService
.
Constructor Summary | |
---|---|
EmbeddedNeo(String storeDir)
Creates an embedded NeoService with a store located in
storeDir , which will be created if it doesn't already
exist. |
|
EmbeddedNeo(String storeDir,
Map<String,String> params)
A non-standard way of creating an embedded NeoService
with a set of configuration parameters. |
Method Summary | |
---|---|
Transaction |
beginTx()
Starts a new transaction and associates it with the current thread. |
Node |
createNode()
Creates a new node. |
boolean |
enableRemoteShell()
Enables remote shell access (with default configuration) to this Neo4j instance, if the Neo4j shell component is available on the
classpath. |
boolean |
enableRemoteShell(Map<String,Serializable> initialProperties)
Enables remote shell access to this Neo4j instance, if the Neo4j shell component is available on the classpath. |
Iterable<Node> |
getAllNodes()
Returns all nodes in the node space. |
Config |
getConfig()
Returns a non-standard configuration object. |
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. |
Iterable<RelationshipType> |
getRelationshipTypes()
Returns all relationship types currently in the underlying store. |
String |
getStoreDir()
|
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 . |
void |
shutdown()
Shuts down Neo4j. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EmbeddedNeo(String storeDir)
NeoService
with a store located in
storeDir
, which will be created if it doesn't already
exist.
storeDir
- the store directory for the neo db filespublic EmbeddedNeo(String storeDir, Map<String,String> params)
NeoService
with a set of configuration parameters. Will most likely be removed in
future releases.
storeDir
- the store directory for the db filesparams
- configuration parametersMethod Detail |
---|
public static Map<String,String> loadConfigurations(String file)
Map
. Will most
likely be removed in future releases.
file
- the property file to load
IllegalArgumentException
- if file does not existpublic Node createNode()
NeoService
createNode
in interface NeoService
public Node getNodeById(long id)
NeoService
getNodeById
in interface NeoService
id
- the id of the node
id
if foundpublic Relationship getRelationshipById(long id)
NeoService
getRelationshipById
in interface NeoService
id
- the id of the relationship
id
if foundpublic Node getReferenceNode()
NeoService
getReferenceNode
in interface NeoService
public void shutdown()
NeoService
shutdown
in interface NeoService
public boolean enableRemoteShell()
NeoService
shell
component is available on the
classpath. This method is identical to invoking
enableRemoteShell( null )
.
enableRemoteShell
in interface NeoService
true
if the shell has been enabled,
false
otherwise (false
usually indicates that
the shell
jar dependency is not on the classpath)public boolean enableRemoteShell(Map<String,Serializable> initialProperties)
NeoService
shell
component is available on the classpath. This will
publish a shell access interface on an RMI registry on localhost (with
configurable port and RMI binding name). It can be accessed by a
client that implements org.neo4j.util.shell.ShellClient
from the Neo4J shell
project. Typically, the
shell
binary package is used (see
neo4j.org/download).
The shell is parameterized by a map of properties passed in to this method. Currently, two properties are used:
port
, an Integer
describing the port of the RMI
registry where the Neo4j shell will be bound, defaults to
1337
name
, the String
under which
the Neo4j shell will be bound in the RMI registry, defaults to
shell
enableRemoteShell
in interface NeoService
initialProperties
- a set of properties that will be used to
configure the remote shell, or null
if the default
properties should be used
true
if the shell has been enabled,
false
otherwise (false
usually indicates that
the shell
jar dependency is not on the classpath)public Iterable<RelationshipType> getRelationshipTypes()
NeoService
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).
getRelationshipTypes
in interface NeoService
public Transaction beginTx()
NeoService
beginTx
in interface NeoService
TransactionFailureException
- if unable to start transactionpublic Config getConfig()
public String toString()
toString
in class Object
public String getStoreDir()
public Iterable<Node> getAllNodes()
NeoService
getAllNodes
in interface NeoService
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |