com.tinkerpop.gremlin.structure

Interface Edge

All Superinterfaces:

EdgeTraversal, Element, ElementTraversal<Edge>

All Known Implementing Classes:

DetachedEdge, StrategyEdge

public interface Edge
extends Element, EdgeTraversal

An Edge links two Vertex objects. Along with its Property objects, an Edge has both a Direction and a label. The Direction 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), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Edge.Exceptions Common exceptions to use with an edge.
static interface	Edge.Iterators An interface that provides access to iterators over properties and vertices, without constructing a Traversal object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LABEL The default label to use for an edge.

Method Summary

Modifier and Type	Method and Description
Edge.Iterators	iterators() Gets the Edge.Iterators set.

Methods inherited from interface com.tinkerpop.gremlin.structure.Element

graph, id, keys, label, property, property, remove, value

Methods inherited from interface com.tinkerpop.gremlin.process.graph.EdgeTraversal

properties, propertyMap, start, value, valueMap, valueMap

Methods inherited from interface com.tinkerpop.gremlin.process.graph.ElementTraversal

addBothE, addE, addInE, addOutE, aggregate, aggregate, as, back, between, both, bothE, bothV, branch, cap, cap, choose, choose, coin, count, cyclicPath, dedup, emit, emit, emit, except, except, except, filter, flatMap, fold, fold, group, group, groupCount, groupCount, has, has, has, has, has, has, has, hasNot, identity, in, inE, inject, inV, limit, local, map, match, order, otherV, out, outE, outV, path, profile, range, repeat, retain, retain, retain, sack, sack, sack, sample, select, select, shuffle, sideEffect, simplePath, store, store, subgraph, subgraph, subgraph, subgraph, submit, sum, timeLimit, times, to, toE, toV, tree, tree, unfold, union, until, until, values, where, where, where, withPath, withSack, withSack, withSideEffect

Field Detail

DEFAULT_LABEL

static final java.lang.String DEFAULT_LABEL

The default label to use for an edge. This is typically never used as when an edge is created, an edge label is required to be specified.

See Also:

Constant Field Values

Method Detail

iterators

Edge.Iterators iterators()

Gets the Edge.Iterators set.

Gets the iterators for the Element. Iterators provide low-level access to the data associated with an Element as they do not come with the overhead of Traversal construction. Use iterators in places where performance is most crucial.

Specified by:

iterators in interface Element