com.mware.ge

Interface Edge

All Superinterfaces:

Comparable, EdgeElementLocation, Element, ElementId, ElementLocation, GeObject, GeObjectId

All Known Implementing Classes:

InMemoryEdge, StorableEdge

public interface Edge
extends Element, EdgeElementLocation

Field Summary

Fields

Modifier and Type	Field and Description
static String	IN_OR_OUT_VERTEX_ID_PROPERTY_NAME Meta property name used for queries.
static String	IN_VERTEX_ID_PROPERTY_NAME Meta property name used for queries, sorting, and aggregations
static String	IN_VERTEX_TYPE_PROPERTY_NAME Meta property name used for queries, sorting, and aggregations
static String	LABEL_PROPERTY_NAME Meta property name used for queries, sorting, and aggregations
static String	OUT_VERTEX_ID_PROPERTY_NAME Meta property name used for queries, sorting, and aggregations
static String	OUT_VERTEX_TYPE_PROPERTY_NAME Meta property name used for queries, sorting, and aggregations

Fields inherited from interface com.mware.ge.Element

ID_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
default ElementType	getElementType() Get the type of the element
String	getLabel() The edge label.
default Vertex	getOtherVertex(String myVertexId, Authorizations authorizations) Given a vertexId that represents one side of a relationship, get me the vertex of the other side.
default Vertex	getOtherVertex(String myVertexId, FetchHints 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.
default Vertex	getVertex(Direction direction, Authorizations authorizations) Get the attach vertex on either side of the edge.
default Vertex	getVertex(Direction direction, FetchHints 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.
default String	getVertexType(Direction direction, Authorizations authorizations)
default EdgeVertices	getVertices(Authorizations authorizations) Gets both in and out vertices of this edge.
default EdgeVertices	getVertices(FetchHints fetchHints, Authorizations authorizations) Gets both in and out vertices of this edge.
ExistingEdgeMutation	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.

Methods inherited from interface com.mware.ge.Element

addPropertyValue, addPropertyValue, compareTo, deleteProperties, deleteProperty, deleteProperty, deleteProperty, getAuthorizations, getEndTime, getExtendedData, getExtendedData, getExtendedData, getExtendedData, getExtendedDataTableNames, getFetchHints, getGraph, getHiddenVisibilities, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, getTimestamp, getVisibility, isHidden, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyVisible, markPropertyVisible, markPropertyVisible, markPropertyVisible, setProperty, setProperty, softDeleteProperties, softDeleteProperty, softDeleteProperty

Methods inherited from interface com.mware.ge.GeObject

getId, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValues

Methods inherited from interface com.mware.ge.ElementLocation

edge, vertex

Methods inherited from interface com.mware.ge.ElementId

create, edge, getId, vertex

Field Detail

LABEL_PROPERTY_NAME

static final String LABEL_PROPERTY_NAME

Meta property name used for queries, sorting, and aggregations

See Also:

Constant Field Values

OUT_VERTEX_ID_PROPERTY_NAME

static final String OUT_VERTEX_ID_PROPERTY_NAME

Meta property name used for queries, sorting, and aggregations

See Also:

Constant Field Values

OUT_VERTEX_TYPE_PROPERTY_NAME

static final String OUT_VERTEX_TYPE_PROPERTY_NAME

Meta property name used for queries, sorting, and aggregations

See Also:

Constant Field Values

IN_VERTEX_ID_PROPERTY_NAME

static final String IN_VERTEX_ID_PROPERTY_NAME

Meta property name used for queries, sorting, and aggregations

See Also:

Constant Field Values

IN_VERTEX_TYPE_PROPERTY_NAME

static final String IN_VERTEX_TYPE_PROPERTY_NAME

Meta property name used for queries, sorting, and aggregations

See Also:

Constant Field Values

IN_OR_OUT_VERTEX_ID_PROPERTY_NAME

static final String IN_OR_OUT_VERTEX_ID_PROPERTY_NAME

Meta property name used for queries. The property represents either the in or the out vertex id.

See Also:

Constant Field Values

Method Detail

getLabel

String getLabel()

The edge label.

Specified by:

getLabel in interface EdgeElementLocation

getVertexId

String getVertexId(Direction direction)

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

Specified by:

getVertexId in interface EdgeElementLocation

Parameters:

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

Returns:

The id of the vertex.

getVertex

default 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.

getVertexType

default String getVertexType(Direction direction,
                             Authorizations authorizations)

getVertex

default Vertex getVertex(Direction direction,
                         FetchHints 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

default 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

default Vertex getOtherVertex(String myVertexId,
                              FetchHints fetchHints,
                              Authorizations authorizations)

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

getVertices

default EdgeVertices getVertices(Authorizations authorizations)

Gets both in and out vertices of this edge.

getVertices

default EdgeVertices getVertices(FetchHints fetchHints,
                                 Authorizations authorizations)

Gets both in and out vertices of this edge.

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.

getElementType

default ElementType getElementType()

Description copied from interface: ElementId

Get the type of the element

Specified by:

getElementType in interface ElementId

Returns:

element type