org.neolumin.vertexium

Interface Edge

All Superinterfaces:

Element

public interface Edge
extends Element

Method Summary

Methods

Modifier and Type	Method and Description
String	getLabel() The edge label.
Vertex	getOtherVertex(String myVertexId, Authorizations authorizations) Given a vertexId that represents one side of a relationship, get me the vertex of the other side.
Vertex	getOtherVertex(String myVertexId, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Given a vertexId that represents one side of a relationship, get me the vertex of the other side.
String	getOtherVertexId(String myVertexId) Given a vertexId that represents one side of a relationship, get me the id of the other side.
Vertex	getVertex(Direction direction, Authorizations authorizations) Get the attach vertex on either side of the edge.
Vertex	getVertex(Direction direction, EnumSet<FetchHint> fetchHints, Authorizations authorizations) Get the attach vertex on either side of the edge.
String	getVertexId(Direction direction) Get the attach vertex id on either side of the edge.
ExistingEdgeMutation	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.

Methods inherited from interface org.neolumin.vertexium.Element

addPropertyValue, addPropertyValue, getAuthorizations, getGraph, getId, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValues, getVisibility, isHidden, markPropertyHidden, markPropertyHidden, markPropertyVisible, markPropertyVisible, mergeProperties, removeProperty, removeProperty, setProperty, setProperty

Method Detail

getLabel

String getLabel()

The edge label.

getVertexId

String getVertexId(Direction direction)

Get the attach vertex id on either side of the edge.

Parameters:

direction - The side of the edge to get the vertex id from (IN or OUT).

Returns:

The id of the vertex.

getVertex

Vertex getVertex(Direction direction,
               Authorizations authorizations)

Get the attach vertex on either side of the edge.

Parameters:

direction - The side of the edge to get the vertex from (IN or OUT).

Returns:

The vertex.

getVertex

Vertex getVertex(Direction direction,
               EnumSet<FetchHint> fetchHints,
               Authorizations authorizations)

Get the attach vertex on either side of the edge.

Parameters:

direction - The side of the edge to get the vertex from (IN or OUT).

fetchHints - Hint on what should be fetched from the datastore.

Returns:

The vertex.

getOtherVertexId

String getOtherVertexId(String myVertexId)

Given a vertexId that represents one side of a relationship, get me the id of the other side.

getOtherVertex

Vertex getOtherVertex(String myVertexId,
                    Authorizations authorizations)

Given a vertexId that represents one side of a relationship, get me the vertex of the other side.

getOtherVertex

Vertex getOtherVertex(String myVertexId,
                    EnumSet<FetchHint> fetchHints,
                    Authorizations authorizations)

Given a vertexId that represents one side of a relationship, get me the vertex of the other side.

prepareMutation

ExistingEdgeMutation prepareMutation()

Prepares a mutation to allow changing multiple property values at the same time. This method is similar to Graph#prepareEdge(Visibility, Authorizations) in that it allows multiple properties to be changed and saved in a single mutation.

Specified by:

prepareMutation in interface Element

Returns:

The mutation builder.