org.apache.tinkerpop.gremlin.structure.util.star

Class StarGraph.StarEdge

java.lang.Object

org.apache.tinkerpop.gremlin.structure.util.star.StarGraph.StarElement<Edge>

org.apache.tinkerpop.gremlin.structure.util.star.StarGraph.StarEdge

All Implemented Interfaces:

Edge, Element, Attachable<Edge>

Direct Known Subclasses:

StarGraph.StarInEdge, StarGraph.StarOutEdge

Enclosing class:

StarGraph

public abstract class StarGraph.StarEdge
extends StarGraph.StarElement<Edge>
implements Edge

Nested Class Summary

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

Edge.Exceptions

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.util.Attachable

Attachable.Exceptions, Attachable.Method

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	otherId

Fields inherited from class org.apache.tinkerpop.gremlin.structure.util.star.StarGraph.StarElement

id, label

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

DEFAULT_LABEL

Method Summary

Modifier and Type	Method and Description
<V> Iterator<Property<V>>	properties(String... propertyKeys) Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys.
<V> Property<V>	property(String key, V value) Add or set a property value for the Element given its key.
void	remove() Removes the Element from the graph.
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.star.StarGraph.StarElement

equals, get, graph, hashCode, id, label

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, inVertex, outVertex

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

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Attachable

attach

Field Detail

otherId

protected final Object otherId

Method Detail

property

public <V> Property<V> property(String key,
                                V value)

Description copied from interface: Element

Add or set a property value for the Element given its key.

Specified by:

property in interface Element

properties

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

Description copied from interface: Edge

Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys. If no keys are provide then return all the properties.

Specified by:

properties in interface Edge

Specified by:

properties in interface Element

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

remove

public void remove()

Description copied from interface: Element

Removes the Element from the graph.

Specified by:

remove in interface Element

toString

public String toString()

Overrides:

toString in class Object