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

A

addNode(String, int, int) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to a new node, and return the new node as the result.

addVertex(String, int, int, byte[]) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to the binary value bytes.

addVertex(String, int, int, double) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to the double value d.

addVertex(String, int, int, int) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to the integer value i.

addVertex(String, int, int, Node) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to the node n.

addVertex(String, int, int, String) - Method in class com.e4graph.Node

Add a new vertex with the given name at the position specified by the insert order io and the given rank, and set its value to the string value s.

AUTOCOMMIT - Static variable in class com.e4graph.Storage

AUTOCOMMIT may be set in the state of a Storage, meaning that the storage is auto-committed from time to time by the e4Graph runtime system (off by default).

AUTOGC - Static variable in class com.e4graph.Storage

AUTOGC may be set in the state of a Storage, meaning that the e4Graph runtime performs GCs on this storage as needed (on by default).

B

BIGPREALLOC - Static variable in class com.e4graph.Storage

BIGPREALLOC may be set in the state of a Storage, meaning that big areas are pre-allocated to hold newly created nodes and vertices (off by default).

BYTES - Static variable in class com.e4graph.Vertex

BYTES is a possible value for the type of the value of a vertex, denoting a value of type array of byte.

bytesValue - Variable in class com.e4graph.Value

This field contains a binary value if the type field is BYTES.

C

close() - Method in class com.e4graph.Storage

Close the storage, potentially committing any unsaved changes.

com.e4graph - package com.e4graph

commit() - Method in class com.e4graph.Storage

Commit any unsaved changes in this storage to persistent storage.

COMMITATCLOSE - Static variable in class com.e4graph.Storage

COMMITATCLOSE may be set in the state of a Storage, meaning that the storage should be committed when closed (on by default).

COMPACTATCLOSE - Static variable in class com.e4graph.Storage

COMPACTATCLOSE may be set in the state of a Storage, meaning that the storag is compacted to its smallest possible on-disk size when it is closed (off by default).

containingNode() - Method in class com.e4graph.Vertex

Retrieve the node in which this vertex appears, or null if the vertex is detached.

copyTo(Storage, boolean) - Method in class com.e4graph.Storage

Copy the contents of this storage (including any uncommitted changes) to the other storage, and if forceCommit is true, force a commit action on the other storage after the copy.

D

DEFAULTSTATE - Static variable in class com.e4graph.Storage

DEFAULTSTATE denotes the default state of a Storage, consisting of COMMITATCLOSE, OPENGC and AUTOGC.

delete() - Method in class com.e4graph.Storage

Delete the persistent form of this storage.

detach() - Method in class com.e4graph.Node

Detach this node, which means ensuring that all vertices that have this node as their value are detached.

detach() - Method in class com.e4graph.Vertex

Detach this vertex from the node (if any) in which it appears.

doGC() - Method in class com.e4graph.Storage

Do a garbage collection on this storage now.

DOUBLE - Static variable in class com.e4graph.Vertex

DOUBLE is a possible value for the type of the value of a vertex, denoting a double (64 bit floating point) value.

doubleValue - Variable in class com.e4graph.Value

This field contains a double (64 bit floating point) value if the type field is DOUBLE.

driver() - Method in class com.e4graph.Storage

Retrieve the String for the driver used to manage persistence for this storage.

E

equals(Node) - Method in class com.e4graph.Node

Compares two nodes for equality.

equals(Storage) - Method in class com.e4graph.Storage

Two storages are equal if their storageIndex values are the same.

exists(String) - Method in class com.e4graph.Node

Does a vertex with the given name exist within this node?

exists(String, int) - Method in class com.e4graph.Node

Are there at least nth vertices with the given name within this node?

G

GCBEFORECOMMIT - Static variable in class com.e4graph.Storage

GCBEFORECOMMIT may be set in the state of a Storage, meaning that a GC is performed on this storage before it is committed (off by default).

getBytes() - Method in class com.e4graph.Vertex

Retrieve the binary value of this vertex.

getBytes(String) - Method in class com.e4graph.Node

Retrieve the value of the first vertex with the given name, which must be of type binary.

getBytesByRank(int) - Method in class com.e4graph.Node

Retrieve the binary value of the vertex identified by the given rank.

getDouble() - Method in class com.e4graph.Vertex

Retrieve the double (64 bit floating point) value of this vertex.

getDouble(String) - Method in class com.e4graph.Node

Retrieve the value of the first vertex with the given name, which must be of type double.

getDoubleByRank(int) - Method in class com.e4graph.Node

Retrieve the double value of the vertex identified by the given rank.

getGeneration() - Method in class com.e4graph.Node

Returns the generation of the storage containing this node.

getGeneration() - Method in class com.e4graph.Storage

Retrieve the generation index for this storage.

getGeneration() - Method in class com.e4graph.Vertex

Retrieve the generation of the storage containing this vertex.

getIndex() - Method in class com.e4graph.Node

Returns the value of the nodeIndex field.

getIndex() - Method in class com.e4graph.Storage

Retrieve the storageIndex for this storage.

getIndex() - Method in class com.e4graph.Vertex

Retrieve the vertexIndex field for this vertex, which is a unique (within its storage) value identifying its underlying e4Graph vertex.

getInt() - Method in class com.e4graph.Vertex

Retrieve the integer value of this vertex.

getInt(String) - Method in class com.e4graph.Node

Retrieve the value of the first vertex with the given name, which must be of type integer.

getIntByRank(int) - Method in class com.e4graph.Node

Retrieve the integer value of the vertex identified by the given rank.

getIterator() - Method in class com.e4graph.Node

Returns an iterator that iterates over the vertices of this node.

getIterator(int) - Method in class com.e4graph.Node

Returns an iterator that iterates over the vertices of this node that have the given type.

getIterator(String) - Method in class com.e4graph.Node

Returns an iterator that iterates over the vertices of this node that have the given name.

getIterator(String, int) - Method in class com.e4graph.Node

Returns an iterator that iterates over the vertices of this node that have the given name and type.

getNode() - Method in class com.e4graph.Storage

Create a new detached node in this storage and return the Node object representing it.

getNode() - Method in class com.e4graph.Vertex

Retrieve the Node value of this vertex.

getNode(String) - Method in class com.e4graph.Node

Retrieve the value of the first vertex with the given name, which must be of type Node.

getNodeByRank(int) - Method in class com.e4graph.Node

Retrieve the Node value of the vertex identified by the given rank.

getNthBytes(String, int) - Method in class com.e4graph.Node

Retrieve the value of the nth vertex with the given name, which must be of type binary.

getNthDouble(String, int) - Method in class com.e4graph.Node

Retrieve the value of the nth vertex with the given name, which must be of type double.

getNthInt(String, int) - Method in class com.e4graph.Node

Retrieve the value of the nth vertex with the given name, which must be of type integer.

getNthNode(String, int) - Method in class com.e4graph.Node

Retrieve the value of the nth vertex with the given name, which must be of type Node.

getNthString(String, int) - Method in class com.e4graph.Node

Retrieve the value of the nth vertex with the given name, which must be of type String.

getNthValue(String, int) - Method in class com.e4graph.Node

This is a general mechanism to retrieve the value of the nth vertex with the given name, without a-priori having to know the type of the value.

getParentIterator() - Method in class com.e4graph.Node

Returns an iterator that iterates over the parents of this node.

getRoot() - Method in class com.e4graph.Storage

Retrieve a Node representing the currently designated root node of this storage.

getRootNode() - Method in class com.e4graph.Node

Retrieve a Node for the currently designated root node of the storage containing this node.

getRootNode() - Method in class com.e4graph.Vertex

Retrieve a Node object for the currently designated root node of the storage containing this vertex.

getState() - Method in class com.e4graph.Storage

Retrieve the current storage state.

getStorage() - Method in class com.e4graph.Node

Retrieve a Storage for the storage containing this node.

getStorage() - Method in class com.e4graph.Vertex

Retrieve a Storage for the storage containing this vertex.

getStorage(int, int) - Static method in class com.e4graph.Storage

Retrieves a Storage object for a currently open storage, given its storageIndex.

getStorageIndex() - Method in class com.e4graph.Node

Returns the value of the storageIndex field.

getStorageIndex() - Method in class com.e4graph.Storage

Retrieve the storageIndex for this storage.

getStorageIndex() - Method in class com.e4graph.Vertex

Retrieve the storageIndex field for this vertex, which is a unique value identifying the storage containing this vertex.

getStorageIterator() - Static method in class com.e4graph.Storage

Create an iterator that iterates over all storages that are accessible in Java.

getString() - Method in class com.e4graph.Vertex

Retrieve the String value of this vertex.

getString(String) - Method in class com.e4graph.Node

Retrieve the value of the first vertex with the given name, which must be of type String.

getStringByRank(int) - Method in class com.e4graph.Node

Retrieve the String value of the vertex identified by the given rank.

getUserData() - Method in class com.e4graph.Node

Retrieve an arbitrary integer value associated by the user program with this node.

getUserData() - Method in class com.e4graph.Vertex

Retrieve an arbitrary integer value associated with this vertex by the user program.

getValue() - Method in class com.e4graph.Vertex

Retrieve the value of this vertex without a-priori knowing the type of the value.

getValue(String) - Method in class com.e4graph.Node

This is a general mechanism to retrieve the value of the first vertex with the given name without a-priori knowing the type of its value.

getValueByRank(int) - Method in class com.e4graph.Node

Retreive the value of a vertex identified by rank without a-priori knowing the type of the value.

getVertex(String) - Method in class com.e4graph.Node

Obtain a Vertex object for the first vertex with the given name.

getVertex(String, byte[]) - Method in class com.e4graph.Storage

Create a new detached vertex with the given name and the binary value bytes, and return the Vertex object representing it.

getVertex(String, double) - Method in class com.e4graph.Storage

Create a new detached vertex with the given name and the double value d, and return the Vertex object representing it.

getVertex(String, int) - Method in class com.e4graph.Node

Obtain a Vertex object for the nth vertex with the given name.

getVertex(String, int) - Method in class com.e4graph.Storage

Create a new detached vertex with the given name and integer value i, and return the Vertex object representing it.

getVertex(String, Node) - Method in class com.e4graph.Storage

getVertex(String, String) - Method in class com.e4graph.Storage

Create a new detached vertex with the given name and the string value s, and return the Vertex object representing it.

getVertexByRank(int) - Method in class com.e4graph.Node

Obtain a Vertex object for the vertex with the given rank.

H

hasNext() - Method in class com.e4graph.ParentIterator

Does this iterator have a next element?

hasNext() - Method in class com.e4graph.StorageIterator

Is there another storage to iterate over?

hasNext() - Method in class com.e4graph.VertexIterator

Does this iterator have a next element?

I

ILLEGAL - Static variable in class com.e4graph.Vertex

ILLEGAL is a possible value for the type of the value of a vertex, denoting an illegal value type.

IncorrectVertexTypeException - exception com.e4graph.IncorrectVertexTypeException.

IncorrectVertexTypeException() - Constructor for class com.e4graph.IncorrectVertexTypeException

INTEGER - Static variable in class com.e4graph.Vertex

INTEGER is a possible value for the type of the value of a vertex, denoting an integer value type.

integerValue - Variable in class com.e4graph.Value

This field contains an integer value if the type field is INTEGER.

INVALID - Static variable in class com.e4graph.Node

This value represents the nodeIndex for an invalid node.

INVALID - Static variable in class com.e4graph.Storage

This value represents the storageIndex of an invalid storage.

INVALID - Static variable in class com.e4graph.Vertex

This value represents the vertexIndex for an invalid vertex.

InvalidPositionException - exception com.e4graph.InvalidPositionException.

InvalidPositionException() - Constructor for class com.e4graph.InvalidPositionException

IOAFTER - Static variable in class com.e4graph.Node

IOAFTER is one of the acceptable values for an insert order specification, denoting that the value should be inserted as the vertex after the specified rank (that is, rank + 1).

IOAT - Static variable in class com.e4graph.Node

IOAT is one of the acceptable values for an insert order specification, denoting the value should be inserted at the specified rank.

IOBEFORE - Static variable in class com.e4graph.Node

IOBEFORE is one of the acceptable values for an insert order specification, denoting that the value should be inserted as the vertex before the specified rank (that is, rank - 1).

IOFIRST - Static variable in class com.e4graph.Node

IOFIRST is one of the acceptable values for an insert order specification, denoting that the value should be inserted as the (currently) first vertex of this node, before all current vertices.

IOLAST - Static variable in class com.e4graph.Node

IOLAST is one of the acceptable values for an insert order specification, denoting that the value should be inserted as the (currently) last vertex of this node, after all current vertices.

IONONE - Static variable in class com.e4graph.Node

IONONE is one of the acceptable values for an insert order specification, denoting an illegal or meaningless insert order.

isDetached() - Method in class com.e4graph.Node

A node is detached iff all vertices that have this node as their value are themselves detached.

isDetached() - Method in class com.e4graph.Vertex

A vertex is detached if it is not contained in any node.

isDirty() - Method in class com.e4graph.Storage

Are there uncommitted changes in this storage?

isRoot() - Method in class com.e4graph.Node

Is this node the currently designated root node for its storage?

isValid() - Method in class com.e4graph.Node

Determines whether this node is valid, which is true if neither its nodeIndex nor its storageIndex are the value INVALID.

isValid() - Method in class com.e4graph.Storage

A storage is valid if the underlying e4Graph storage is valid and its storageIndex is not the constant INVALID.

isValid() - Method in class com.e4graph.Vertex

A vertex is valid if neither its vertexIndex and storageIndex are the constant value INVALID, and the underlying e4Graph vertex is valid.

M

markDirty() - Method in class com.e4graph.Storage

Mark this storage as having uncommitted changes that have not yet been saved to persistent storage.

METAKIT - Static variable in class com.e4graph.Storage

This is the name of the default driver to use to manage the persistence of this storage.

moveVertex(Vertex, int, int) - Method in class com.e4graph.Node

Move the given vertex to the position specified by the insert order io and the given rank, within this node.

moveVertex(Vertex, int, int) - Method in class com.e4graph.Vertex

Move the given vertex to the position specified by the insert order io and the given offset relative to this vertex, in the node containing this vertex.

N

name() - Method in class com.e4graph.Storage

Retrieve the String name of this storage.

name() - Method in class com.e4graph.Vertex

Retrieve the name of this vertex.

nameInParent() - Method in class com.e4graph.Node

Retrieve the name of the first vertex within the first parent node of this node that has this node as its value.

nameInParent(int) - Method in class com.e4graph.Node

Retrieve the name of the first vertex within the nth parent node of this node that has this node as its value.

needsGC() - Method in class com.e4graph.Storage

Is a garbage collection needed for this storage (it is needed if there may be detached nodes and vertices which are not referenced by the user program).

next() - Method in class com.e4graph.ParentIterator

Get the next parent.

next() - Method in class com.e4graph.StorageIterator

Get the next storage to visit.

next() - Method in class com.e4graph.VertexIterator

Get the next element of the iteration.

next(int) - Method in class com.e4graph.Vertex

Retrieve the next vertex after this one in the node containing this vertex, or null if there's none or if this vertex is detached.

Node - class com.e4graph.Node.

NODE - Static variable in class com.e4graph.Vertex

NODE is a possible value for the type of the value of a vertex, denoting a value of type com.e4graph.Node.

nodeValue - Variable in class com.e4graph.Value

This field contains a Node value if the type field is NODE.

NoSuchNodeException - exception com.e4graph.NoSuchNodeException.

NoSuchNodeException() - Constructor for class com.e4graph.NoSuchNodeException

NoSuchVertexException - exception com.e4graph.NoSuchVertexException.

NoSuchVertexException() - Constructor for class com.e4graph.NoSuchVertexException

O

occurrenceCount() - Method in class com.e4graph.Node

How many vertices anywhere within this storage have this node as their value?

occurrenceCount(Node) - Method in class com.e4graph.Node

How many vertices within the given node have this node as their value?

OPENGC - Static variable in class com.e4graph.Storage

OPENGC may be set in the state of a Storage, meaning that a GC should be performed (as necessary) when the storage is opened (on by default).

P

parent() - Method in class com.e4graph.Node

Retrieve a Node representing the first parent node of this node.

parent(int) - Method in class com.e4graph.Node

Retrieve a Node representing the nth parent node of this node.

parentCount() - Method in class com.e4graph.Node

How many parent nodes does this node have?

ParentIterator - class com.e4graph.ParentIterator.

ParentIterator(Node) - Constructor for class com.e4graph.ParentIterator

Constructor that creates an iterator that visits every parent of the given node.

parentRank(Node) - Method in class com.e4graph.Node

What is the rank of the parent node p in the list of parent nodes for this node?

prev(int) - Method in class com.e4graph.Vertex

Retrieve the previous vertex before this one in the node containing this vertex, or null if there's none or if this vertex is detached.

R

rank() - Method in class com.e4graph.Vertex

Retrieve the rank of this vertex in the node in which it appears.

rankInParent() - Method in class com.e4graph.Node

Retrieve the rank of the first vertex within the first parent node of this node that has this node as its value.

rankInParent(int) - Method in class com.e4graph.Node

Retrieve the rank of the first vertex within the nth parent node of this node that has this node as its value.

remove() - Method in class com.e4graph.ParentIterator

Remove method -- always throws UnsupportedOperationException.

remove() - Method in class com.e4graph.StorageIterator

The remove() operation always throws UnsupportedOperationException.

remove() - Method in class com.e4graph.VertexIterator

Remove method -- always throws UnsupportedOperationException.

rename(String) - Method in class com.e4graph.Vertex

Rename this vertex to another name.

renameVertex(int, String) - Method in class com.e4graph.Node

Rename the vertex with the given rank.

S

set(byte[]) - Method in class com.e4graph.Vertex

Set the value of this vertex to the binary value bs.

set(double) - Method in class com.e4graph.Vertex

Set the value of this vertex to the double (64 bit floatin point) value d.

set(int) - Method in class com.e4graph.Vertex

Set the value of this vertex to the integer value v.

set(Node) - Method in class com.e4graph.Vertex

Set the value of this vertex to the Node n.

set(String) - Method in class com.e4graph.Vertex

Set the value of this vertex to the String s.

setNode() - Method in class com.e4graph.Vertex

Set the value of this vertex to a new node and return the Node object representing the new node.

setNode(String) - Method in class com.e4graph.Node

Set the first vertex with the given name to a new node and return the new node as the result.

setNodeByRank(int) - Method in class com.e4graph.Node

Set the vertex with the given rank to a new node and return the new node as the result.

setNthNode(String, int) - Method in class com.e4graph.Node

Set the nth vertex with the given name to a new node and return the new node as the result.

setNthVertex(String, int, byte[]) - Method in class com.e4graph.Node

Set the nth vertex with the given name to the binary value bs.

setNthVertex(String, int, double) - Method in class com.e4graph.Node

Set the nth vertex with the given name to the double value d.

setNthVertex(String, int, int) - Method in class com.e4graph.Node

Set the nth vertex with the given name to the integer value i.

setNthVertex(String, int, Node) - Method in class com.e4graph.Node

Set the nth vertex with the given name to the node n.

setNthVertex(String, int, String) - Method in class com.e4graph.Node

Set the nth vertex with the given name to the string value s.

setRoot(Node) - Method in class com.e4graph.Storage

Set the currently designated root node of this storage to the e4Graph node denoted by the given newRoot.

setState(int) - Method in class com.e4graph.Storage

Set the storage state to a new state, with changes taking effect immediately and affecting subsequent behavior.

setUserData(int) - Method in class com.e4graph.Node

User programs can persistently store and associate an arbitrary integer value with this node.

setUserData(int) - Method in class com.e4graph.Vertex

Persistently associate an arbitrary integer value with this vertex.

setVertex(String, byte[]) - Method in class com.e4graph.Node

Set the first vertex with the given name to the binary value bytes.

setVertex(String, double) - Method in class com.e4graph.Node

Set the first vertex with the given name to the double value d.

setVertex(String, int) - Method in class com.e4graph.Node

Set the first vertex with the given name to the integer value i.

setVertex(String, Node) - Method in class com.e4graph.Node

Set the first vertex with the given name to the node n.

setVertex(String, String) - Method in class com.e4graph.Node

Set the first vertex with the given name to the string value s.

setVertexByRank(int, byte[]) - Method in class com.e4graph.Node

Set the vertex with the given rank to the binary value bs.

setVertexByRank(int, double) - Method in class com.e4graph.Node

Set the vertex with the given rank to the double value d.

setVertexByRank(int, int) - Method in class com.e4graph.Node

Set the vertex with the given rank to the integer value i.

setVertexByRank(int, Node) - Method in class com.e4graph.Node

Set the vertex with the given rank to the node n.

setVertexByRank(int, String) - Method in class com.e4graph.Node

Set the vertex with the given rank to the string value s.

Storage - class com.e4graph.Storage.

Storage() - Constructor for class com.e4graph.Storage

Default constructor, constructs an invalid storage.

Storage(String, String) - Constructor for class com.e4graph.Storage

Constructor that uses the given name and driver to construct a storage.

Storage(String, String, int) - Constructor for class com.e4graph.Storage

Constructor that in addition to a name and driver for the storage also accepts an initial configuration state.

StorageCreationException - exception com.e4graph.StorageCreationException.

StorageCreationException() - Constructor for class com.e4graph.StorageCreationException

StorageIsNotOpenException - exception com.e4graph.StorageIsNotOpenException.

StorageIsNotOpenException() - Constructor for class com.e4graph.StorageIsNotOpenException

StorageIterator - class com.e4graph.StorageIterator.

StorageIterator() - Constructor for class com.e4graph.StorageIterator

Constructor that returns an iterator that will iterate over all open storages in turn.

STRING - Static variable in class com.e4graph.Vertex

STRING is a possible value for the type of the value of a vertex, denoting a java.lang.String value.

stringValue - Variable in class com.e4graph.Value

This field contains a String if the type field is STRING.

T

type - Variable in class com.e4graph.Value

This field contains one of the constants defined in class Vertex denoting the various possible types of vertex values.

type() - Method in class com.e4graph.Vertex

Retrieve the type of the value of this vertex.

V

Value - class com.e4graph.Value.

Value() - Constructor for class com.e4graph.Value

version() - Static method in class com.e4graph.Storage

Retrieves the version string for the e4Graph library in use.

Vertex - class com.e4graph.Vertex.

vertexCount() - Method in class com.e4graph.Node

Returns the vertex count for this node.

vertexCountWithName(String) - Method in class com.e4graph.Node

How many vertices in this node have the given name?

vertexCountWithType(int) - Method in class com.e4graph.Node

How many vertices in this node have the given type?

VertexIterator - class com.e4graph.VertexIterator.

VertexIterator(Node) - Constructor for class com.e4graph.VertexIterator

Constructor that creates an iterator that visits every vertex in this node.

VertexIterator(Node, int) - Constructor for class com.e4graph.VertexIterator

Constructor that creates an iterator that visits only vertices with the given type, in the given node.

VertexIterator(Node, String) - Constructor for class com.e4graph.VertexIterator

Constructor that creates an iterator that visits only vertices with the given name, in the given node.

VertexIterator(Node, String, int) - Constructor for class com.e4graph.VertexIterator

Constructor that creates an iterator that visits only vertices with the given name and type, in the given node.

vertexName(int) - Method in class com.e4graph.Node

Obtain the String name of the vertex with the given rank.

vertexRank(String) - Method in class com.e4graph.Node

Obtain the rank of the first vertex with the given name.

vertexRank(String, int) - Method in class com.e4graph.Node

Obtain the rank of the nth vertex with the given name.

vertexType(String) - Method in class com.e4graph.Node

Obtain the type of the value of the first vertex with the given name, as defined in class Vertex.

vertexType(String, int) - Method in class com.e4graph.Node

Obtain the type of the value of the nth vertex with the given name, as defined in class Vertex.

vertexTypeByRank(int) - Method in class com.e4graph.Node

Obtain the type of the value of the vertex with the given rank, as defined in class Vertex.

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