Index (Neo 1.0-b6 API)

Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A B C D E F G H I L N O P R S T V

## A

ALL - Static variable in interface org.neo4j.api.core.ReturnableEvaluator
  A returnable evaluator that returns all nodes encountered.
ALL_BUT_START_NODE - Static variable in interface org.neo4j.api.core.ReturnableEvaluator
  A returnable evaluator that returns all nodes except start node.

## B

begin() - Static method in class org.neo4j.api.core.Transaction
  Starts a new transaction.

## C

createAndRegisterRelationshipType(String) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
createNode() - Method in class org.neo4j.api.core.EmbeddedNeo
createNode() - Method in interface org.neo4j.api.core.NeoService
  Creates a new node.
createRelationshipTo(Node, RelationshipType) - Method in interface org.neo4j.api.core.Node
  Creates a relationship between this node and another node.
currentNode() - Method in interface org.neo4j.api.core.TraversalPosition
  Return the current node.
currentPosition() - Method in interface org.neo4j.api.core.Traverser
  Returns the current traversal postion.

## D

delete() - Method in interface org.neo4j.api.core.Node
  Deletes this node.
delete() - Method in interface org.neo4j.api.core.Relationship
  Deletes this relationship.
depth() - Method in interface org.neo4j.api.core.TraversalPosition
  Returns the current traversal depth.
DEPTH_ONE - Static variable in interface org.neo4j.api.core.StopEvaluator
  Traverses to depth 1.
Direction - Enum in org.neo4j.api.core
  Defines relationship directions used to when getting relationships from a node or when creating traversers.

## E

EmbeddedNeo - Class in org.neo4j.api.core
  An implementation of `NeoService` that is used to embed Neo in an application.
EmbeddedNeo(String) - Constructor for class org.neo4j.api.core.EmbeddedNeo
  Creates an embedded `NeoService` with a store located in `storeDir`, which will be created if it doesn't already exist.
EmbeddedNeo(Class<? extends RelationshipType>, String) - Constructor for class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
enableRemoteShell() - Method in class org.neo4j.api.core.EmbeddedNeo
enableRemoteShell(Map<String, Serializable>) - Method in class org.neo4j.api.core.EmbeddedNeo
enableRemoteShell() - Method in interface org.neo4j.api.core.NeoService
  Enables remote shell access (with default configuration) to this Neo instance, if the Neo4j `shell` component is available on the classpath.
enableRemoteShell(Map<String, Serializable>) - Method in interface org.neo4j.api.core.NeoService
  Enables remote shell access to this Neo instance, if the Neo4j `shell` component is available on the classpath.
END_OF_NETWORK - Static variable in interface org.neo4j.api.core.StopEvaluator
  Traverser until the end of network, this evaluator returns `false` all the time.

## F

failure() - Method in class org.neo4j.api.core.Transaction
  Marks this transaction as failed, which means that it will inexplicably be rolled back upon invocation of `Transaction.finish()`.
finish() - Method in class org.neo4j.api.core.Transaction
  Commits or marks this transaction for rollback, depending on whether `Transaction.success()` or `Transaction.failure()` has been previously invoked.

## G

getAllNodes() - Method in interface org.neo4j.api.core.Traverser
  Returns a collection of all nodes returned by this traverser.
getEndNode() - Method in interface org.neo4j.api.core.Relationship
  Returns the end node of this relationship.
getId() - Method in interface org.neo4j.api.core.Node
  Returns the unique id of this node.
getId() - Method in interface org.neo4j.api.core.Relationship
  Returns the unique id of this relationship.
getNodeById(long) - Method in class org.neo4j.api.core.EmbeddedNeo
getNodeById(long) - Method in interface org.neo4j.api.core.NeoService
  Looks up a node by id.
getNodes() - Method in interface org.neo4j.api.core.Relationship
  Returns the two nodes that are attached to this relationship.
getOtherNode(Node) - Method in interface org.neo4j.api.core.Relationship
  A convenience operation that, given a node that is attached to this relationship, returns the other node.
getProperty(String) - Method in interface org.neo4j.api.core.Node
  Returns the property value associated with the given key.
getProperty(String, Object) - Method in interface org.neo4j.api.core.Node
  Returns the property value associated with the given key, or a default value.
getProperty(String) - Method in interface org.neo4j.api.core.Relationship
  See `Node.getProperty(String)`
getProperty(String, Object) - Method in interface org.neo4j.api.core.Relationship
  See `Node.getProperty(String, Object)`
getPropertyKeys() - Method in interface org.neo4j.api.core.Node
  Returns all currently valid property keys, or an empty iterable if this node has no properties.
getPropertyKeys() - Method in interface org.neo4j.api.core.Relationship
  See `Node.getPropertyKeys()`
getPropertyValues() - Method in interface org.neo4j.api.core.Node
  Returns all currently valid property values, or an empty iterable if this node has no properties.
getPropertyValues() - Method in interface org.neo4j.api.core.Relationship
  See `Node.getPropertyValues()`
getReferenceNode() - Method in class org.neo4j.api.core.EmbeddedNeo
getReferenceNode() - Method in interface org.neo4j.api.core.NeoService
  Returns the reference node, which is a "starting point" in the node space.
getRelationships() - Method in interface org.neo4j.api.core.Node
  Returns all the relationships attached to this node.
getRelationships(RelationshipType...) - Method in interface org.neo4j.api.core.Node
  Returns all the relationships of any of the types in `types` that are attached to this node, regardless of direction.
getRelationships(Direction) - Method in interface org.neo4j.api.core.Node
  Returns all `OUTGOING` or `INCOMING` relationships from this node.
getRelationships(RelationshipType, Direction) - Method in interface org.neo4j.api.core.Node
  Returns all relationships with the given type and direction that are attached to this node.
getRelationshipType(String) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Might not be needed now that relationship types are `created dynamically`.
getRelationshipTypes() - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Might not be needed now that relationship types are `created dynamically`.
getSingleRelationship(RelationshipType, Direction) - Method in interface org.neo4j.api.core.Node
  Returns the only relationship of a given type and direction that is attached to this node, or `null`.
getStartNode() - Method in interface org.neo4j.api.core.Relationship
  Returns the start node of this relationship.
getType() - Method in interface org.neo4j.api.core.Relationship
  Returns the type of this relationship.

## H

hasProperty(String) - Method in interface org.neo4j.api.core.Node
  Returns `true` if this node has a property accessible through the given key, `false` otherwise.
hasProperty(String) - Method in interface org.neo4j.api.core.Relationship
  See `Node.hasProperty(String)`
hasRelationship() - Method in interface org.neo4j.api.core.Node
  Returns `true` if there are any relationships attached to this node, `false` otherwise.
hasRelationship(RelationshipType...) - Method in interface org.neo4j.api.core.Node
  Returns `true` if there are any relationships of any of the types in `types` attached to this node (regardless of direction), `false` otherwise.
hasRelationship(Direction) - Method in interface org.neo4j.api.core.Node
  Returns `true` if there are any relationships in the given direction attached to this node, `false` otherwise.
hasRelationship(RelationshipType, Direction) - Method in interface org.neo4j.api.core.Node
  Returns `true` if there are any relationships of the given relationship type and direction attached to this node, `false` otherwise.
hasRelationshipType(String) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.

## I

isReturnableNode(TraversalPosition) - Method in interface org.neo4j.api.core.ReturnableEvaluator
  Method invoked by traverser to see if current position is a returnable node.
isStopNode(TraversalPosition) - Method in interface org.neo4j.api.core.StopEvaluator
  Method invoked by traverser to see if current position is a stop node.
isType(RelationshipType) - Method in interface org.neo4j.api.core.Relationship
  Indicates whether this relationship is of the type `type`.
iterator() - Method in interface org.neo4j.api.core.Traverser
  Returns an iterator for this traverser.

## L

lastRelationshipTraversed() - Method in interface org.neo4j.api.core.TraversalPosition
  Return the last relationship traversed, may be null.

## N

name() - Method in interface org.neo4j.api.core.RelationshipType
  Returns the name of the relationship type.
NeoService - Interface in org.neo4j.api.core
  The main access point to a running Neo instance.
Node - Interface in org.neo4j.api.core
  A node in the network with properties and relationships to other entities.
notStartNode() - Method in interface org.neo4j.api.core.TraversalPosition
  Returns `true` if the current position is anywhere except on the start node, `false` if it is on the start node.

## O

org.neo4j.api.core - package org.neo4j.api.core

## P

previousNode() - Method in interface org.neo4j.api.core.TraversalPosition
  Returns the previous node, may be null.

## R

registerEnumRelationshipTypes(Class<? extends RelationshipType>) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
registerRelationshipType(String) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
registerRelationshipTypes(Iterable<RelationshipType>) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
registerRelationshipTypes(RelationshipType[]) - Method in class org.neo4j.api.core.EmbeddedNeo
  Deprecated. Not required now that relationship types are `created dynamically`. Will be removed in next release.
Relationship - Interface in org.neo4j.api.core
  A relationship between two nodes in the network.
RelationshipType - Interface in org.neo4j.api.core
  A relationship type is a mandatory property on all relationships that is used to navigate the node space.
removeProperty(String) - Method in interface org.neo4j.api.core.Node
  Removes and returns the property associated with the given key.
removeProperty(String) - Method in interface org.neo4j.api.core.Relationship
  See `Node.removeProperty(String)`
ReturnableEvaluator - Interface in org.neo4j.api.core
  A client hook for evaluating whether a specific node should be returned from a traverser.
returnedNodesCount() - Method in interface org.neo4j.api.core.TraversalPosition
  Returns the number of nodes returned by traverser so far.
reverse() - Method in enum org.neo4j.api.core.Direction
  Reverses the direction returning `Direction.INCOMING` if this equals `Direction.OUTGOING`, `Direction.OUTGOING` if this equals `Direction.INCOMING` or `Direction.BOTH` if this equals `Direction.BOTH`.

## S

setProperty(String, Object) - Method in interface org.neo4j.api.core.Node
  Sets the property value for the given key to `value`.
setProperty(String, Object) - Method in interface org.neo4j.api.core.Relationship
  See `Node.setProperty(String, Object)`
shutdown() - Method in class org.neo4j.api.core.EmbeddedNeo
shutdown() - Method in interface org.neo4j.api.core.NeoService
  Shuts down Neo.
StopEvaluator - Interface in org.neo4j.api.core
  A client hook for evaluating whether the traverser should traverse beyond a specific node.
success() - Method in class org.neo4j.api.core.Transaction
  Marks this transaction as successful, which means that it will be commited upon invocation of `Transaction.finish()` unless `Transaction.failure()` has or will be invoked before then.

## T

Transaction - Class in org.neo4j.api.core
  A utility class to manage transactions in Neo.
TraversalPosition - Interface in org.neo4j.api.core
  Encapsulates information about the current traversal position.
traverse(Traverser.Order, StopEvaluator, ReturnableEvaluator, RelationshipType, Direction) - Method in interface org.neo4j.api.core.Node
  Instantiates a traverser that will start at this node and traverse according to the given order and evaluators along the specified relationship type and direction.
traverse(Traverser.Order, StopEvaluator, ReturnableEvaluator, RelationshipType, Direction, RelationshipType, Direction) - Method in interface org.neo4j.api.core.Node
  Instantiates a traverser that will start at this node and traverse according to the given order and evaluators along the two specified relationship type and direction pairs.
traverse(Traverser.Order, StopEvaluator, ReturnableEvaluator, Object...) - Method in interface org.neo4j.api.core.Node
  Instantiates a traverser that will start at this node and traverse according to the given order and evaluators along the specified relationship type and direction pairs.
Traverser - Interface in org.neo4j.api.core
  A traversal in the node space.
Traverser.Order - Enum in org.neo4j.api.core
  Defines a traversal order as used by the traversal framework.

## V

valueOf(String) - Static method in enum org.neo4j.api.core.Direction
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.neo4j.api.core.Traverser.Order
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.neo4j.api.core.Direction
  Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.neo4j.api.core.Traverser.Order
  Returns an array containing the constants of this enum type, in the order they're declared.

A B C D E F G H I L N O P R S T V

Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright © 2007 Neo4j. All Rights Reserved.