com.tinkerpop.gremlin.structure.strategy

Class StrategyVertex

java.lang.Object

com.tinkerpop.gremlin.structure.strategy.StrategyElement

com.tinkerpop.gremlin.structure.strategy.StrategyVertex

All Implemented Interfaces:

ElementTraversal<Vertex>, VertexTraversal, Element, Element.Iterators, StrategyWrapped, WrappedVertex<Vertex>, Vertex, Vertex.Iterators

public class StrategyVertex
extends StrategyElement
implements Vertex, StrategyWrapped, WrappedVertex<Vertex>, Vertex.Iterators

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StrategyVertex.StrategyVertexIterator

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

Vertex.Exceptions, Vertex.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.Vertex

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
StrategyVertex(Vertex baseVertex, StrategyGraph strategyGraph)

Method Summary

Modifier and Type	Method and Description
Edge	addEdge(java.lang.String label, Vertex inVertex, java.lang.Object... keyValues) Add an outgoing edge to the vertex with provided label and edge properties as key/value pairs.
java.util.Iterator<Edge>	edgeIterator(Direction direction, java.lang.String... edgeLabels) Gets an Iterator of incident edges.
Vertex	getBaseVertex()
Graph	graph() Get the graph that this element is within.
java.lang.Object	id() Gets the unique identifier for the graph Element.
Vertex.Iterators	iterators() Get the Vertex.Iterators implementation associated with this Vertex.
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> VertexProperty<V>	property(java.lang.String key) Get a Property for the Element given its key.
<V> VertexProperty<V>	property(java.lang.String key, V value) Add or set a property value for the Element given its key.
<V> java.util.Iterator<VertexProperty<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, java.lang.String... labels) Gets an Iterator of adjacent vertices.

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.structure.Vertex

property, singleProperty

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

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

StrategyVertex

public StrategyVertex(Vertex baseVertex,
                      StrategyGraph strategyGraph)

Method Detail

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

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

iterators

public Vertex.Iterators iterators()

Description copied from interface: Vertex

Get the Vertex.Iterators implementation associated with this Vertex.

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

Specified by:

iterators in interface Vertex

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.

remove

public void remove()

Description copied from interface: Element

Removes the Element from the graph.

Specified by:

remove in interface Element

getBaseVertex

public Vertex getBaseVertex()

Specified by:

getBaseVertex in interface WrappedVertex<Vertex>

addEdge

public Edge addEdge(java.lang.String label,
                    Vertex inVertex,
                    java.lang.Object... keyValues)

Description copied from interface: Vertex

Add an outgoing edge to the vertex with provided label and edge properties as key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.

Specified by:

addEdge in interface Vertex

Parameters:

label - The label of the edge

inVertex - The vertex to receive an incoming edge from the current vertex

keyValues - The key/value pairs to turn into edge properties

Returns:

the newly created edge

property

public <V> VertexProperty<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

Specified by:

property in interface Vertex

property

public <V> VertexProperty<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

Specified by:

property in interface Vertex

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

edgeIterator

public java.util.Iterator<Edge> edgeIterator(Direction direction,
                                             java.lang.String... edgeLabels)

Description copied from interface: Vertex.Iterators

Gets an Iterator of incident edges.

Specified by:

edgeIterator in interface Vertex.Iterators

Parameters:

direction - The incident direction of the edges to retrieve off this vertex

edgeLabels - The labels of the edges to retrieve. If no labels are provided, then get all edges.

Returns:

An iterator of edges meeting the provided specification

vertexIterator

public java.util.Iterator<Vertex> vertexIterator(Direction direction,
                                                 java.lang.String... labels)

Description copied from interface: Vertex.Iterators

Gets an Iterator of adjacent vertices.

Specified by:

vertexIterator in interface Vertex.Iterators

Parameters:

direction - The adjacency direction of the vertices to retrieve off this vertex

labels - The labels of the edges associated with the vertices to retrieve. If no labels are provided, then get all edges.

Returns:

An iterator of vertices meeting the provided specification

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<VertexProperty<V>> propertyIterator(java.lang.String... propertyKeys)

Description copied from interface: Vertex.Iterators

Get an Iterator of properties.

Specified by:

propertyIterator in interface Element.Iterators

Specified by:

propertyIterator in interface Vertex.Iterators