com.tinkerpop.blueprints

Interface Edge

All Superinterfaces:

Element

All Known Implementing Classes:

EventEdge, IdEdge, PartitionEdge, ReadOnlyEdge, WrappedEdge

public interface Edge
extends Element

An Edge links two vertices. Along with its key/value properties, an edge has both a directionality and a label. The directionality determines which vertex is the tail vertex (out vertex) and which vertex is the head vertex (in vertex). The edge label determines the type of relationship that exists between the two vertices. Diagrammatically, outVertex ---label---> inVertex.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Method Summary

Methods

Modifier and Type	Method and Description
String	getLabel() Return the label associated with the edge.
Vertex	getVertex(Direction direction) Return the tail/out or head/in vertex.

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, remove, removeProperty, setProperty

Method Detail

getVertex

Vertex getVertex(Direction direction)
                 throws IllegalArgumentException

Return the tail/out or head/in vertex.

Parameters:

direction - whether to return the tail/out or head/in vertex

Returns:

the tail/out or head/in vertex

Throws:

IllegalArgumentException - is thrown if a direction of both is provided

getLabel

String getLabel()

Return the label associated with the edge.

Returns:

the edge label