Interface Entity

All Superinterfaces:

MapAccessor

All Known Subinterfaces:

Node, Relationship

@Immutable
public interface Entity
extends MapAccessor

A uniquely identifiable property container that can form part of a Neo4j graph.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
String	elementId()	A unique id for this Entity.
long	id()	Deprecated. superseded by elementId()

Methods inherited from interface MapAccessor

asMap, asMap, containsKey, get, keys, size, values, values

Modifier and Type	Method	Description
Map<String,Object>	asMap()	Return the underlying map as a map of string keys and values converted using Value.asObject().
<T> Map<String,T>	asMap(Function<Value,T> mapFunction)	Return the underlying map as a map of string keys and values converted using the supplied function.
boolean	containsKey(String key)	Check if the list of keys contains the given key
Value	get(String key)	Retrieve the value of the property with the given key
Iterable<String>	keys()	Retrieve the keys of the underlying map
int	size()	Retrieve the number of entries in this map
Iterable<Value>	values()	Retrieve all values of the underlying collection
<T> Iterable<T>	values(Function<Value,T> mapFunction)	Map and retrieve all values of the underlying collection

Method Details

id

@Deprecated
long id()

Deprecated.

superseded by elementId()

A unique id for this Entity. Ids are guaranteed to remain stable for the duration of the session they were found in, but may be re-used for other entities after that. As such, if you want a public identity to use for your entities, attaching an explicit 'id' property or similar persistent and unique identifier is a better choice.

Please note that depending on server configuration numeric id might not be available and accessing it will result in IllegalStateException.

Returns:

the id of this entity

elementId

String elementId()

A unique id for this Entity.

It is recommended to attach an explicit 'id' property or similar persistent and unique identifier if you want a public identity to use for your entities.

Returns:

the id of this entity