com.tinkerpop.blueprints.Edge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blueprints-core Show documentation

Core interfaces and utilities for Blueprints

There is a newer version: 2.6.0

package com.tinkerpop.blueprints;

/**
 * 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)
 */
public interface Edge extends Element {

    /**
     * Return the tail/out or head/in vertex.
     *
     * @param direction whether to return the tail/out or head/in vertex
     * @return the tail/out or head/in vertex
     * @throws IllegalArgumentException is thrown if a direction of both is provided
     */
    public Vertex getVertex(Direction direction) throws IllegalArgumentException;

    /**
     * Return the label associated with the edge.
     *
     * @return the edge label
     */
    public String getLabel();
}