overflowdb

Class NodeRef<N extends NodeDb>

java.lang.Object

overflowdb.NodeRef<N>

All Implemented Interfaces:

Element, Node

public abstract class NodeRef<N extends NodeDb>
extends java.lang.Object
implements Node

Lightweight (w.r.t. memory usage) reference to for an NodeDb, which is stored in the `node` member. When running low on memory (as detected by {HeapUsageMonitor}), the {ReferenceManager} may set that member to `null`, so that the garbage collector can free up some heap, thus avoiding @OutOfMemoryError. Note that this model only works if nothing else holds references to the NodeDb - which is therefor strongly discouraged. Instead, the entire application should only ever hold onto NodeRef instances. When the `node` member is currently null, but is then required (e.g. to lookup a property or an edge), the node will be fetched from the underlying OdbStorage. When OdbGraph is started from an existing storage location, only NodeRef instances are created - the nodes are lazily on demand as described above.

Field Summary

Fields

Modifier and Type	Field and Description
protected Graph	graph
protected long	id

Constructor Summary

Constructors

Constructor and Description
NodeRef(Graph graph, long id) used when creating a node without the underlying instance at hand
NodeRef(Graph graph, N node)

Method Summary

Modifier and Type	Method and Description
Edge	addEdge(java.lang.String label, Node inNode, java.util.Map<java.lang.String,java.lang.Object> keyValues) Add an outgoing edge to the node with provided label and edge properties as key/value pairs.
Edge	addEdge(java.lang.String label, Node inNode, java.lang.Object... keyValues) Add an outgoing edge to the node with provided label and edge properties as key/value pairs.
void	addEdgeSilent(java.lang.String label, Node inNode, java.util.Map<java.lang.String,java.lang.Object> keyValues) Add an outgoing edge to the node with provided label and edge properties as key/value pairs.
void	addEdgeSilent(java.lang.String label, Node inNode, java.lang.Object... keyValues) Add an outgoing edge to the node with provided label and edge properties as key/value pairs.
java.util.Iterator<Node>	both()
java.util.Iterator<Node>	both(java.lang.String... edgeLabels)
java.util.Iterator<Edge>	bothE()
java.util.Iterator<Edge>	bothE(java.lang.String... edgeLabels)
protected void	clear()
boolean	equals(java.lang.Object obj)
N	get()
java.util.Optional<N>	getOption()
Graph	graph()
int	hashCode()
long	id()
java.util.Iterator<Node>	in()
java.util.Iterator<Node>	in(java.lang.String... edgeLabels)
java.util.Iterator<Edge>	inE()
java.util.Iterator<Edge>	inE(java.lang.String... edgeLabels)
boolean	isCleared()
boolean	isSet()
java.util.Iterator<Node>	out()
java.util.Iterator<Node>	out(java.lang.String... edgeLabels)
java.util.Iterator<Edge>	outE()
java.util.Iterator<Edge>	outE(java.lang.String... edgeLabels)
protected void	persist(byte[] data)
<A> A	property(PropertyKey<A> key)
java.lang.Object	property(java.lang.String propertyKey)
java.util.Set<java.lang.String>	propertyKeys()
java.util.Map<java.lang.String,java.lang.Object>	propertyMap() Map with all properties
<A> java.util.Optional<A>	propertyOption(PropertyKey<A> key)
java.util.Optional<java.lang.Object>	propertyOption(java.lang.String key)
void	remove()
void	removeProperty(java.lang.String key)
protected byte[]	serializeWhenDirty()
void	setNode(N node)
void	setProperty(Property<?> property)
<A> void	setProperty(PropertyKey<A> key, A value)
void	setProperty(java.lang.String key, java.lang.Object value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface overflowdb.Element

label

Field Detail

id

protected final long id

graph

protected final Graph graph

Constructor Detail

NodeRef

public NodeRef(Graph graph,
               N node)

NodeRef

public NodeRef(Graph graph,
               long id)

used when creating a node without the underlying instance at hand

Method Detail

isSet

public boolean isSet()

isCleared

public boolean isCleared()

clear

protected void clear()

serializeWhenDirty

protected byte[] serializeWhenDirty()

persist

protected void persist(byte[] data)

get

public final N get()

getOption

public final java.util.Optional<N> getOption()

setNode

public void setNode(N node)

id

public long id()

Specified by:

id in interface Node

graph

public Graph graph()

Specified by:

graph in interface Element

remove

public void remove()

Specified by:

remove in interface Element

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

addEdge

public Edge addEdge(java.lang.String label,
                    Node inNode,
                    java.lang.Object... keyValues)

Description copied from interface: Node

Add an outgoing edge to the node with provided label and edge properties as key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.

Specified by:

addEdge in interface Node

addEdge

public Edge addEdge(java.lang.String label,
                    Node inNode,
                    java.util.Map<java.lang.String,java.lang.Object> keyValues)

Description copied from interface: Node

Add an outgoing edge to the node with provided label and edge properties as key/value pairs.

Specified by:

addEdge in interface Node

addEdgeSilent

public void addEdgeSilent(java.lang.String label,
                          Node inNode,
                          java.lang.Object... keyValues)

Description copied from interface: Node

Add an outgoing edge to the node with provided label and edge properties as key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values. Just like {{{addEdge2}}, but doesn't instantiate and return a dummy edge

Specified by:

addEdgeSilent in interface Node

addEdgeSilent

public void addEdgeSilent(java.lang.String label,
                          Node inNode,
                          java.util.Map<java.lang.String,java.lang.Object> keyValues)

Description copied from interface: Node

Add an outgoing edge to the node with provided label and edge properties as key/value pairs. Just like {{{addEdge2}}, but doesn't instantiate and return a dummy edge

Specified by:

addEdgeSilent in interface Node

propertyMap

public java.util.Map<java.lang.String,java.lang.Object> propertyMap()

Description copied from interface: Element

Map with all properties

Specified by:

propertyMap in interface Element

property

public java.lang.Object property(java.lang.String propertyKey)

Specified by:

property in interface Element

property

public <A> A property(PropertyKey<A> key)

Specified by:

property in interface Element

propertyOption

public <A> java.util.Optional<A> propertyOption(PropertyKey<A> key)

Specified by:

propertyOption in interface Element

propertyOption

public java.util.Optional<java.lang.Object> propertyOption(java.lang.String key)

Specified by:

propertyOption in interface Element

setProperty

public <A> void setProperty(PropertyKey<A> key,
                            A value)

Specified by:

setProperty in interface Element

setProperty

public void setProperty(Property<?> property)

Specified by:

setProperty in interface Element

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Specified by:

setProperty in interface Element

propertyKeys

public java.util.Set<java.lang.String> propertyKeys()

Specified by:

propertyKeys in interface Element

removeProperty

public void removeProperty(java.lang.String key)

Specified by:

removeProperty in interface Element

out

public java.util.Iterator<Node> out()

Specified by:

out in interface Node

out

public java.util.Iterator<Node> out(java.lang.String... edgeLabels)

Specified by:

out in interface Node

in

public java.util.Iterator<Node> in()

Specified by:

in in interface Node

in

public java.util.Iterator<Node> in(java.lang.String... edgeLabels)

Specified by:

in in interface Node

both

public java.util.Iterator<Node> both()

Specified by:

both in interface Node

both

public java.util.Iterator<Node> both(java.lang.String... edgeLabels)

Specified by:

both in interface Node

outE

public java.util.Iterator<Edge> outE()

Specified by:

outE in interface Node

outE

public java.util.Iterator<Edge> outE(java.lang.String... edgeLabels)

Specified by:

outE in interface Node

inE

public java.util.Iterator<Edge> inE()

Specified by:

inE in interface Node

inE

public java.util.Iterator<Edge> inE(java.lang.String... edgeLabels)

Specified by:

inE in interface Node

bothE

public java.util.Iterator<Edge> bothE()

Specified by:

bothE in interface Node

bothE

public java.util.Iterator<Edge> bothE(java.lang.String... edgeLabels)

Specified by:

bothE in interface Node

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object