org.janusgraph.core

Interface JanusGraphEdge

All Superinterfaces:

org.apache.tinkerpop.gremlin.structure.Edge, org.apache.tinkerpop.gremlin.structure.Element, Idfiable, JanusGraphElement, JanusGraphRelation, Removable

All Known Implementing Classes:

AbstractEdge, CacheEdge, StandardEdge

public interface JanusGraphEdge
extends JanusGraphRelation, org.apache.tinkerpop.gremlin.structure.Edge

A JanusGraphEdge connects two JanusGraphVertex. It extends the functionality provided by Blueprint's Edge and is a special case of a JanusGraphRelation.

Author:

Matthias Bröcheler (http://www.matthiasb.com)

See Also:

Edge, JanusGraphRelation, EdgeLabel

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Element

org.apache.tinkerpop.gremlin.structure.Element.Exceptions

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

org.apache.tinkerpop.gremlin.structure.Edge.Exceptions

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

DEFAULT_LABEL

Method Summary

Modifier and Type	Method and Description
default EdgeLabel	edgeLabel() Returns the edge label of this edge
default JanusGraphVertex	inVertex()
JanusGraphVertex	otherVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex) Returns the vertex at the opposite end of the edge.
default JanusGraphVertex	outVertex()
JanusGraphVertex	vertex(org.apache.tinkerpop.gremlin.structure.Direction dir) Returns the vertex for the specified direction.
default Iterator<org.apache.tinkerpop.gremlin.structure.Vertex>	vertices(org.apache.tinkerpop.gremlin.structure.Direction direction)

Methods inherited from interface org.janusgraph.core.JanusGraphRelation

direction, getType, isEdge, isIncidentOn, isLoop, isProperty, longId, value

Methods inherited from interface org.janusgraph.core.JanusGraphElement

graph, hasId, id, isLoaded, isNew, isRemoved, property, remove, valueOrNull

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element

keys, label, properties, property, values

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Edge

bothVertices, properties

Method Detail

edgeLabel

default EdgeLabel edgeLabel()

Returns the edge label of this edge

Returns:

edge label of this edge

vertex

JanusGraphVertex vertex(org.apache.tinkerpop.gremlin.structure.Direction dir)

Returns the vertex for the specified direction. The direction cannot be Direction.BOTH.

Parameters:

dir - Direction of IN or OUT

Returns:

the vertex for the specified direction

outVertex

default JanusGraphVertex outVertex()

Specified by:

outVertex in interface org.apache.tinkerpop.gremlin.structure.Edge

inVertex

default JanusGraphVertex inVertex()

Specified by:

inVertex in interface org.apache.tinkerpop.gremlin.structure.Edge

otherVertex

JanusGraphVertex otherVertex(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Returns the vertex at the opposite end of the edge.

Parameters:

vertex - vertex on which this edge is incident

Returns:

The vertex at the opposite end of the edge.

Throws:

InvalidElementException - if the edge is not incident on the specified vertex

vertices

default Iterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(org.apache.tinkerpop.gremlin.structure.Direction direction)

Specified by:

vertices in interface org.apache.tinkerpop.gremlin.structure.Edge