All the nodes in a NeoGraph.

An identification scheme can be defined throught the register and add methods. The id_property attribute defines where the local ID (that is the ID managed by the collection) is stored in each node.

Introduced properties

type ID_TYPE: Serializable

neo4j :: NeoNodeCollection :: ID_TYPE

The type of the local IDs.
fun [](id: ID_TYPE): NeoNode

neo4j :: NeoNodeCollection :: []

Retrieve the node that has the specified local id.
fun compact

neo4j :: NeoNodeCollection :: compact

Optimize the collection, possibly by rewritting it.
fun create_node: NeoNode

neo4j :: NeoNodeCollection :: create_node

Add a new node to the graph and return it.
fun enlarge(cap: Int)

neo4j :: NeoNodeCollection :: enlarge

Enlarge the collection to have at least the specified capacity.
fun get_or_null(id: ID_TYPE): nullable NeoNode

neo4j :: NeoNodeCollection :: get_or_null

Retrieve the node that has the specified local id, or return null.
fun has_id(id: ID_TYPE): Bool

neo4j :: NeoNodeCollection :: has_id

There is a node that has the specified local id?
fun id_from_jsonable(id: nullable Serializable): ID_TYPE

neo4j :: NeoNodeCollection :: id_from_jsonable

Convert the specified JSON value into a local ID.
fun id_of(node: NeoNode): ID_TYPE

neo4j :: NeoNodeCollection :: id_of

Return the local ID of the node.
protected fun id_of=(node: NeoNode, id: ID_TYPE)

neo4j :: NeoNodeCollection :: id_of=

Set the local ID of the specified node.
fun id_property: String

neo4j :: NeoNodeCollection :: id_property

The property of the nodes that hold the local ID.
protected fun id_property=(id_property: String)

neo4j :: NeoNodeCollection :: id_property=

The property of the nodes that hold the local ID.
abstract fun register(node: NeoNode)

neo4j :: NeoNodeCollection :: register

Add the specified node to the graph and set its local ID.
abstract fun remove_at(id: ID_TYPE)

neo4j :: NeoNodeCollection :: remove_at

Remove the node with the specified local ID.
fun remove_node(node: NeoNode)

neo4j :: NeoNodeCollection :: remove_node

Remove the specified node.

Redefined properties

redef type SELF: NeoNodeCollection

neo4j $ NeoNodeCollection :: SELF

Type of this instance, automatically specialized in every class
redef abstract fun add(node: NeoNode)

neo4j $ NeoNodeCollection :: add

Add the specified node to the graph assuming that its local ID is already set.
redef fun clear

neo4j $ NeoNodeCollection :: clear

Remove all items
redef fun remove(node: nullable Object)

neo4j $ NeoNodeCollection :: remove

Remove an occurrence of item
redef fun remove_all(node: nullable Object)

neo4j $ NeoNodeCollection :: remove_all

Remove all occurrences of item

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type CONCURRENT: ConcurrentCollection[E]

core :: Collection :: CONCURRENT

Type of the concurrent variant of this collection
type ID_TYPE: Serializable

neo4j :: NeoNodeCollection :: ID_TYPE

The type of the local IDs.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun [](id: ID_TYPE): NeoNode

neo4j :: NeoNodeCollection :: []

Retrieve the node that has the specified local id.
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
abstract fun add(item: E)

core :: SimpleCollection :: add

Add item to this collection.
fun add_all(coll: Collection[E])

core :: SimpleCollection :: add_all

Add each item of coll.
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun as_random: Queue[E]

core :: SimpleCollection :: as_random

Return a random proxy queue where result.take is random.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun clear

core :: RemovableCollection :: clear

Remove all items
fun combinations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations

All r-length combinations on self (in same order) without repeated elements.
fun combinations_with_replacement(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations_with_replacement

All r-length combination on self (in same order) with repeated elements.
fun compact

neo4j :: NeoNodeCollection :: compact

Optimize the collection, possibly by rewritting it.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun count(item: nullable Object): Int

core :: Collection :: count

How many occurrences of item are in the collection?
fun create_node: NeoNode

neo4j :: NeoNodeCollection :: create_node

Add a new node to the graph and return it.
fun enlarge(cap: Int)

neo4j :: NeoNodeCollection :: enlarge

Enlarge the collection to have at least the specified capacity.
fun first: E

core :: Collection :: first

Return the first item of the collection
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_or_null(id: ID_TYPE): nullable NeoNode

neo4j :: NeoNodeCollection :: get_or_null

Retrieve the node that has the specified local id, or return null.
fun has(item: nullable Object): Bool

core :: Collection :: has

Is item in the collection ?
fun has_all(other: Collection[nullable Object]): Bool

core :: Collection :: has_all

Does the collection contain at least each element of other?
fun has_any(other: Collection[nullable Object]): Bool

core :: Collection :: has_any

Does the collection contain at least one element of other?
fun has_exactly(other: Collection[nullable Object]): Bool

core :: Collection :: has_exactly

Does the collection contain exactly all the elements of other?
fun has_id(id: ID_TYPE): Bool

neo4j :: NeoNodeCollection :: has_id

There is a node that has the specified local id?
fun has_only(item: nullable Object): Bool

core :: Collection :: has_only

Is the collection contain only item?
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun id_from_jsonable(id: nullable Serializable): ID_TYPE

neo4j :: NeoNodeCollection :: id_from_jsonable

Convert the specified JSON value into a local ID.
fun id_of(node: NeoNode): ID_TYPE

neo4j :: NeoNodeCollection :: id_of

Return the local ID of the node.
protected fun id_of=(node: NeoNode, id: ID_TYPE)

neo4j :: NeoNodeCollection :: id_of=

Set the local ID of the specified node.
fun id_property: String

neo4j :: NeoNodeCollection :: id_property

The property of the nodes that hold the local ID.
protected fun id_property=(id_property: String)

neo4j :: NeoNodeCollection :: id_property=

The property of the nodes that hold the local ID.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
fun is_empty: Bool

core :: Collection :: is_empty

Is there no item in the collection?
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun iterator: Iterator[E]

core :: Collection :: iterator

Get a new iterator on the collection.
fun join(separator: nullable Text, last_separator: nullable Text): String

core :: Collection :: join

Concatenate and separate each elements with separator.
fun length: Int

core :: Collection :: length

Number of items in the collection.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
fun not_empty: Bool

core :: Collection :: not_empty

Alias for not is_empty.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun permutations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: permutations

All r-length permutations on self (all possible ordering) without repeated elements.
fun plain_to_s: String

core :: Collection :: plain_to_s

Concatenate elements without separators
fun product(r: Int): Collection[SequenceRead[E]]

core :: Collection :: product

Cartesian product, over r times self.
fun rand: E

core :: Collection :: rand

Return a random element form the collection
abstract fun register(node: NeoNode)

neo4j :: NeoNodeCollection :: register

Add the specified node to the graph and set its local ID.
abstract fun remove(item: nullable Object)

core :: RemovableCollection :: remove

Remove an occurrence of item
fun remove_all(item: nullable Object)

core :: RemovableCollection :: remove_all

Remove all occurrences of item
abstract fun remove_at(id: ID_TYPE)

neo4j :: NeoNodeCollection :: remove_at

Remove the node with the specified local ID.
fun remove_node(node: NeoNode)

neo4j :: NeoNodeCollection :: remove_node

Remove the specified node.
fun sample(length: Int): Array[E]

core :: Collection :: sample

Return a new array made of (at most) length elements randomly chosen.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_a: Array[E]

core :: Collection :: to_a

Build a new array from a collection
abstract fun to_concurrent: CONCURRENT

core :: Collection :: to_concurrent

Wraps self in a thread-safe collection
fun to_counter: Counter[E]

core :: Collection :: to_counter

Create and fill up a counter with the elements of `self.
fun to_curlslist: CURLSList

core :: Collection :: to_curlslist

Convert Collection[String] to CURLSList
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun to_shuffle: Array[E]

core :: Collection :: to_shuffle

Return a new array made of elements in a random order.
package_diagram neo4j::NeoNodeCollection NeoNodeCollection core::SimpleCollection SimpleCollection neo4j::NeoNodeCollection->core::SimpleCollection serialization::Serializable Serializable core::SimpleCollection->serialization::Serializable core::RemovableCollection RemovableCollection core::SimpleCollection->core::RemovableCollection ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable ...core::RemovableCollection ... ...core::RemovableCollection->core::RemovableCollection neo4j::SequentialNodeCollection SequentialNodeCollection neo4j::SequentialNodeCollection->neo4j::NeoNodeCollection

Ancestors

interface Collection[E: nullable Object]

core :: Collection

The root of the collection hierarchy.
interface Object

core :: Object

The root of the class hierarchy.
interface RemovableCollection[E: nullable Object]

core :: RemovableCollection

Items can be removed from this collection
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

interface SimpleCollection[E: nullable Object]

core :: SimpleCollection

Items can be added to these collections.

Children

class SequentialNodeCollection

neo4j :: SequentialNodeCollection

A Neo4j node collection using a sequential identification scheme.

Class definitions

neo4j $ NeoNodeCollection
# All the nodes in a `NeoGraph`.
#
# An identification scheme can be defined throught the `register` and `add`
# methods. The `id_property` attribute defines where the local ID (that is the
# ID managed by the collection) is stored in each node.
abstract class NeoNodeCollection
	super SimpleCollection[NeoNode]

	# The type of the local IDs.
	type ID_TYPE: Serializable

	# The property of the nodes that hold the local ID.
	var id_property: String

	# Retrieve the node that has the specified local id.
	#
	# Note: The default implementation uses `get_or_null`.
	fun [](id: ID_TYPE): NeoNode do
		var n = get_or_null(id)
		assert n isa NeoNode
		return n
	end

	# Retrieve the node that has the specified local id, or return `null`.
	#
	# Note: The default implementation uses `iterator`.
	fun get_or_null(id: ID_TYPE): nullable NeoNode do
		for n in self do
			if id_of(n) == id then return n
		end
		return null
	end

	# There is a node that has the specified local id?
	#
	# Note: The default implementation uses `get_or_null`.
	fun has_id(id: ID_TYPE): Bool do return get_or_null(id) isa NeoNode

	# Return the local ID of the node.
	fun id_of(node: NeoNode): ID_TYPE do return node[id_property].as(ID_TYPE)

	# Set the local ID of the specified node.
	#
	# Just update the property at `property_id`. Do not check anything.
	protected fun id_of=(node: NeoNode, id: ID_TYPE) do
		node[id_property] = id
	end

	# Enlarge the collection to have at least the specified capacity.
	#
	# The capacity is specified in number of nodes. Used to minimize the
	# number of times the collection need to be resized when adding nodes
	# in batches.
	#
	# Do nothing by default.
	fun enlarge(cap: Int) do end

	# Add the specified node to the graph and set its local ID.
	#
	# SEE: `add`
	# SEE: `create_node`
	fun register(node: NeoNode) is abstract

	# Add the specified node to the graph assuming that its local ID is already set.
	#
	# SEE: `create_node`
	# SEE: `register`
	redef fun add(node) is abstract

	# Add a new node to the graph and return it.
	#
	# Set the local ID of the node before returning it.
	#
	# SEE: `add`
	# SEE: `register`
	fun create_node: NeoNode do
		var node = new NeoNode
		register(node)
		return node
	end

	# Remove the node with the specified local ID.
	fun remove_at(id: ID_TYPE) is abstract

	# Remove the specified node.
	#
	# The local ID is used instead of `==` to seek the node.
	fun remove_node(node: NeoNode) do
		remove_at(id_of(node))
	end

	redef fun clear do
		for node in self do remove_node(node)
	end

	redef fun remove(node) do
		for n in self do
			if node == n then
				remove_node(n)
				return
			end
		end
	end

	redef fun remove_all(node) do
		for n in self do
			if node == n then remove_node(n)
		end
	end

	# Optimize the collection, possibly by rewritting it.
	#
	# The local ID of the elements may be changed by this method.
	fun compact do end
end
lib/neo4j/graph/graph.nit:41,1--155,3

neo4j :: json_graph_store $ NeoNodeCollection
redef class NeoNodeCollection
	# Convert the specified JSON value into a local ID.
	fun id_from_jsonable(id: nullable Serializable): ID_TYPE do return id.as(ID_TYPE)
end
lib/neo4j/graph/json_graph_store.nit:218,1--221,3