Interface Relationship

All Superinterfaces:

Entity, MapAccessor

public interface Relationship
extends Entity

The Relationship interface describes the characteristics of a relationship from a Neo4j graph.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
String	endNodeElementId()	The id of the node where this relationship ends.
long	endNodeId()	Deprecated. superseded by endNodeElementId()
boolean	hasType(String relationshipType)	Test if this relationship has the given type
String	startNodeElementId()	The id of the node where this relationship starts.
long	startNodeId()	Deprecated. superseded by startNodeElementId()
String	type()	Return the type of this relationship.

Methods inherited from interface Entity

elementId, id

Modifier and Type	Method	Description
String	elementId()	A unique id for this Entity.
long	id()	Deprecated. superseded by Entity.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

startNodeId

@Deprecated
long startNodeId()

Deprecated.

superseded by startNodeElementId()

The id of the node where this relationship starts.

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

Returns:

the node id

startNodeElementId

String startNodeElementId()

The id of the node where this relationship starts.

Returns:

the node id

endNodeId

@Deprecated
long endNodeId()

Deprecated.

superseded by endNodeElementId()

The id of the node where this relationship ends.

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

Returns:

the node id

endNodeElementId

String endNodeElementId()

The id of the node where this relationship ends.

Returns:

the node id

type

String type()

Return the type of this relationship.

Returns:

the type name

hasType

boolean hasType(String relationshipType)

Test if this relationship has the given type

Parameters:

relationshipType - the give relationship type

Returns:

true if this relationship has the given relationship type otherwise false