com.tinkerpop.gremlin.structure.strategy

Class StrategyEdge

java.lang.Object

com.tinkerpop.gremlin.structure.strategy.StrategyElement

com.tinkerpop.gremlin.structure.strategy.StrategyEdge

All Implemented Interfaces:

EdgeTraversal, ElementTraversal<Edge>, Edge, Edge.Iterators, Element, Element.Iterators, StrategyWrapped, WrappedEdge<Edge>

public class StrategyEdge
extends StrategyElement
implements Edge, Edge.Iterators, StrategyWrapped, WrappedEdge<Edge>

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StrategyEdge.StrategyEdgeIterator

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.strategy.StrategyElement

baseElement, elementStrategyContext, strategy, strategyGraph

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
StrategyEdge(Edge baseEdge, StrategyGraph strategyGraph)

Method Summary

Modifier and Type	Method and Description
Edge	getBaseEdge()
Graph	graph() Get the graph that this element is within.
java.lang.Object	id() Gets the unique identifier for the graph Element.
Edge.Iterators	iterators() Gets the Edge.Iterators set.
java.util.Set<java.lang.String>	keys() Get the keys of the properties associated with this element.
java.lang.String	label() Gets the label for the graph Element which helps categorize it.
<V> Property<V>	property(java.lang.String key) Get a Property for the Element given its key.
<V> Property<V>	property(java.lang.String key, V value) Add or set a property value for the Element given its key.
<V> java.util.Iterator<Property<V>>	propertyIterator(java.lang.String... propertyKeys) Get an Iterator of properties.
void	remove() Removes the Element from the graph.
java.lang.String	toString()
<V> V	value(java.lang.String key) Get the value of a Property given it's key.
<V> java.util.Iterator<V>	valueIterator(java.lang.String... propertyKeys) Get the values of properties as an Iterator.
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.strategy.StrategyElement

equals, getBaseElement, hashCode

Methods inherited from class java.lang.Object

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

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

Constructor Detail

StrategyEdge

public StrategyEdge(Edge baseEdge,
                    StrategyGraph strategyGraph)

Method Detail

iterators

public Edge.Iterators iterators()

Description copied from interface: Edge

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 Edge

Specified by:

iterators in interface Element

graph

public Graph graph()

Description copied from interface: Element

Get the graph that this element is within.

Specified by:

graph in interface Element

Returns:

the graph of this element

id

public java.lang.Object id()

Description copied from interface: Element

Gets the unique identifier for the graph Element.

Specified by:

id in interface Element

Returns:

The id of the element

label

public java.lang.String label()

Description copied from interface: Element

Gets the label for the graph Element which helps categorize it.

Specified by:

label in interface Element

Returns:

The label of the element

value

public <V> V value(java.lang.String key)
            throws java.util.NoSuchElementException

Description copied from interface: Element

Get the value of a Property given it's key. The default implementation calls Element.property(java.lang.String) and then returns the associated value.

Specified by:

value in interface Element

Throws:

java.util.NoSuchElementException - if the property does not exist on the Element.

keys

public java.util.Set<java.lang.String> keys()

Description copied from interface: Element

Get the keys of the properties associated with this element. The default implementation iterators the properties and stores the keys into a HashSet.

Specified by:

keys in interface Element

Returns:

The property key set

getBaseEdge

public Edge getBaseEdge()

Specified by:

getBaseEdge in interface WrappedEdge<Edge>

property

public <V> Property<V> property(java.lang.String key)

Description copied from interface: Element

Get a Property for the Element given its key. The default implementation calls the raw Element#iterators#propertyIterator.

Specified by:

property in interface Element

property

public <V> Property<V> property(java.lang.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

remove

public void remove()

Description copied from interface: Element

Removes the Element from the graph.

Specified by:

remove in interface Element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

valueIterator

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

Description copied from interface: Element.Iterators

Get the values of properties as an Iterator.

Specified by:

valueIterator in interface Element.Iterators

propertyIterator

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

Description copied from interface: Edge.Iterators

Get an Iterator of properties.

Specified by:

propertyIterator in interface Edge.Iterators

Specified by:

propertyIterator in interface Element.Iterators