io.innerloop.neo4j.client

Class Relationship

java.lang.Object

io.innerloop.neo4j.client.Relationship

public class Relationship
extends java.lang.Object

Represents a Neo4J Relationship.

Relationships connect nodes and are comprised of an id, type and start/end node id's.

Again, similar to Nodes, relationship id's SHOULD NOT BE USED to identify a relationship.

Constructor Summary

Constructors

Constructor and Description
Relationship(long id, java.lang.String type, long startNodeId, long endNodeId, java.util.Map<java.lang.String,java.lang.Object> properties) Creates a new relationship to connect two Nodes.

Method Summary

Modifier and Type	Method and Description
long	getEndNodeId() Retrieves the relationships end node id.
long	getId() Returns this relationship's id.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns a map of properties stored in this Relationship.
long	getStartNodeId() Retrieves the relationships origin node id.
java.lang.String	getType() Returns this node's type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Relationship

public Relationship(long id,
                    java.lang.String type,
                    long startNodeId,
                    long endNodeId,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

Creates a new relationship to connect two Nodes.

Parameters:

id - The Neo4J Specific id for this relationship. Do not use this as a real identifier outside of the scope of this request.

type - The type of this relationship. Usually a verb type name.

startNodeId - The first node that this relationship connects. That is the direction originates from here.

endNodeId - THe end node that this relationship connects. The direction terminates here.

properties - Like Nodes, Relationships can store properties.

Method Detail

getId

public long getId()

Returns this relationship's id. DO NOT USE AS AN IDENTITY BEYOND THE SCOPE OF THIS GRAPH RESULT.

Returns:

a long integer representing this relationship.

getEndNodeId

public long getEndNodeId()

Retrieves the relationships end node id.

Returns:

The end node's id which this relationship connects.

getStartNodeId

public long getStartNodeId()

Retrieves the relationships origin node id.

Returns:

The first node's id which this relationship connects.

getType

public java.lang.String getType()

Returns this node's type. Relationships always have a type.

Returns:

The type of this relationship. Usually a verb type name.

getProperties

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

Returns a map of properties stored in this Relationship.

Returns:

a map of properties.