org.apache.tinkerpop.gremlin.structure.util.detached

Class DetachedEdge

java.lang.Object

org.apache.tinkerpop.gremlin.structure.util.detached.DetachedElement<Edge>

org.apache.tinkerpop.gremlin.structure.util.detached.DetachedEdge

All Implemented Interfaces:

Serializable, Edge, Element, Attachable<Edge>

public class DetachedEdge
extends DetachedElement<Edge>
implements Edge

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 org.apache.tinkerpop.gremlin.structure.Edge

Edge.Exceptions

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.structure.util.detached.DetachedElement

id, label, properties

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

DEFAULT_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachedEdge(Edge edge, boolean withProperties)
	DetachedEdge(Object id, String label, Map<String,Object> properties, <any> outV, <any> inV)

Method Summary

Modifier and Type	Method and Description
static Edge	addTo(Graph graph, DetachedEdge detachedEdge)
Edge	attach(Graph hostGraph)
Edge	attach(Vertex hostVertex)
Vertex	inVertex() Get the incoming/head vertex of this edge.
Vertex	outVertex() Get the outgoing/tail vertex of this edge.
<V> Iterator<Property<V>>	properties(String... propertyKeys) Get an Iterator of properties.
String	toString()
Iterator<Vertex>	vertices(Direction direction) Retrieve the vertex (or vertices) associated with this edge as defined by the direction.

Methods inherited from class org.apache.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 org.apache.tinkerpop.gremlin.structure.Edge

bothVertices

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

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

Constructor Detail

DetachedEdge

protected DetachedEdge(Edge edge,
                       boolean withProperties)

DetachedEdge

public DetachedEdge(Object id,
                    String label,
                    Map<String,Object> properties,
                    <any> outV,
                    <any> inV)

Method Detail

toString

public String toString()

Overrides:

toString in class 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)

inVertex

public Vertex inVertex()

Description copied from interface: Edge

Get the incoming/head vertex of this edge.

Specified by:

inVertex in interface Edge

Returns:

the incoming vertex of the edge

outVertex

public Vertex outVertex()

Description copied from interface: Edge

Get the outgoing/tail vertex of this edge.

Specified by:

outVertex in interface Edge

Returns:

the outgoing vertex of the edge

vertices

public Iterator<Vertex> vertices(Direction direction)

Description copied from interface: Edge

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:

vertices in interface Edge

Parameters:

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

Returns:

An iterator with 1 or 2 vertices

properties

public <V> Iterator<Property<V>> properties(String... propertyKeys)

Description copied from interface: Element

Get an Iterator of properties.

Specified by:

properties in interface Edge

Specified by:

properties in interface Element

Overrides:

properties in class DetachedElement<Edge>