com.tinkerpop.gremlin.structure.util.detached

Class DetachedEdge

java.lang.Object

com.tinkerpop.gremlin.structure.util.detached.DetachedElement<Edge>

com.tinkerpop.gremlin.structure.util.detached.DetachedEdge

All Implemented Interfaces:

EdgeTraversal, ElementTraversal<Edge>, Edge, Edge.Iterators, Element, Element.Iterators, Attachable<Edge>, java.io.Serializable

public class DetachedEdge
extends DetachedElement<Edge>
implements Edge, Edge.Iterators

Represents an Edge that is disconnected from a Graph. "Disconnection" can mean detachment from a Graph in the sense that the Edge was constructed from a Graph instance and this reference was removed or it can mean that the DetachedEdge could have been constructed independently of a Graph instance in the first place.
A DetachedEdge only has reference to the properties and in/out vertices that are associated with it at the time of detachment (or construction) and is not traversable or mutable. Note that the references to the in/out vertices are DetachedVertex instances that only have reference to the Element.id() and Element.label().

Author:

Stephen Mallette (http://stephen.genoprime.com), Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

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

Edge.Exceptions, Edge.Iterators

Field Summary

Fields inherited from class com.tinkerpop.gremlin.structure.util.detached.DetachedElement

id, label, properties

Fields inherited from interface com.tinkerpop.gremlin.structure.Edge

DEFAULT_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachedEdge(Edge edge, boolean withProperties)
	DetachedEdge(java.lang.Object id, java.lang.String label, java.util.Map<java.lang.String,java.lang.Object> properties, org.javatuples.Pair<java.lang.Object,java.lang.String> outV, org.javatuples.Pair<java.lang.Object,java.lang.String> inV)

Method Summary

Modifier and Type	Method and Description
static Edge	addTo(Graph graph, DetachedEdge detachedEdge)
Edge	attach(Graph hostGraph)
Edge	attach(Vertex hostVertex)
Edge.Iterators	iterators() Gets the iterators for the Element.
<V> java.util.Iterator<Property<V>>	propertyIterator(java.lang.String... propertyKeys) Get an Iterator of properties.
java.lang.String	toString()
java.util.Iterator<Vertex>	vertexIterator(Direction direction) Retrieve the vertex (or vertices) associated with this edge as defined by the direction.

Methods inherited from class com.tinkerpop.gremlin.structure.util.detached.DetachedElement

equals, graph, hashCode, id, label, property, property, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

valueIterator

Constructor Detail

DetachedEdge

protected DetachedEdge(Edge edge,
                       boolean withProperties)

DetachedEdge

public DetachedEdge(java.lang.Object id,
                    java.lang.String label,
                    java.util.Map<java.lang.String,java.lang.Object> properties,
                    org.javatuples.Pair<java.lang.Object,java.lang.String> outV,
                    org.javatuples.Pair<java.lang.Object,java.lang.String> inV)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

attach

public Edge attach(Vertex hostVertex)

Specified by:

attach in interface Attachable<Edge>

attach

public Edge attach(Graph hostGraph)

Specified by:

attach in interface Attachable<Edge>

addTo

public static Edge addTo(Graph graph,
                         DetachedEdge detachedEdge)

iterators

public Edge.Iterators iterators()

Description copied from interface: Element

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 Edge

Specified by:

iterators in interface Element

Overrides:

iterators in class DetachedElement<Edge>

vertexIterator

public java.util.Iterator<Vertex> vertexIterator(Direction direction)

Description copied from interface: Edge.Iterators

Retrieve the vertex (or vertices) associated with this edge as defined by the direction. If the direction is Direction.BOTH then the iterator order is: Direction.OUT then Direction.IN.

Specified by:

vertexIterator in interface Edge.Iterators

Parameters:

direction - Get the incoming vertex, outgoing vertex, or both vertices

Returns:

An iterator with 1 or 2 vertices

propertyIterator

public <V> java.util.Iterator<Property<V>> propertyIterator(java.lang.String... propertyKeys)

Description copied from interface: Element.Iterators

Get an Iterator of properties.

Specified by:

propertyIterator in interface Edge.Iterators

Specified by:

propertyIterator in interface Element.Iterators

Overrides:

propertyIterator in class DetachedElement<Edge>