com.tinkerpop.gremlin.structure.strategy

Class StrategyVertexProperty<V>

java.lang.Object

com.tinkerpop.gremlin.structure.strategy.StrategyElement

com.tinkerpop.gremlin.structure.strategy.StrategyVertexProperty<V>

All Implemented Interfaces:

ElementTraversal<VertexProperty>, VertexPropertyTraversal, Element, Element.Iterators, Property<V>, StrategyWrapped, WrappedVertexProperty<VertexProperty<V>>, VertexProperty<V>, VertexProperty.Iterators

public class StrategyVertexProperty<V>
extends StrategyElement
implements VertexProperty<V>, StrategyWrapped, WrappedVertexProperty<VertexProperty<V>>, VertexProperty.Iterators

Author:

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

Nested Class Summary

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

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

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
StrategyVertexProperty(VertexProperty<V> baseVertexProperty, StrategyGraph strategyGraph)

Method Summary

Modifier and Type	Method and Description
Vertex	element() Gets the Vertex that owns this VertexProperty.
VertexProperty<V>	getBaseVertexProperty()
Graph	graph() Get the graph that this element is within.
java.lang.Object	id() Gets the unique identifier for the graph Element.
boolean	isPresent() Whether the property is empty or not.
VertexProperty.Iterators	iterators() Gets the VertexProperty.Iterators set.
java.lang.String	key() The key of the property.
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.
<U> Property<U>	property(java.lang.String key, U value) Add or set a property value for the Element given its key.
<U> java.util.Iterator<Property<U>>	propertyIterator(java.lang.String... propertyKeys) Get an Iterator of properties.
void	remove() Remove the property from the associated element.
java.lang.String	toString()
V	value() The value of the property.
<U> java.util.Iterator<U>	valueIterator(java.lang.String... propertyKeys) Get the values of properties as an Iterator.

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.VertexProperty

empty

Methods inherited from interface com.tinkerpop.gremlin.structure.Property

ifPresent, orElse, orElseGet, orElseThrow

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

property, value

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

properties, propertyMap, start, 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

StrategyVertexProperty

public StrategyVertexProperty(VertexProperty<V> baseVertexProperty,
                              StrategyGraph strategyGraph)

Method Detail

graph

public Graph graph()

Description copied from interface: VertexProperty

Get the graph that this element is within.

Specified by:

graph in interface Element

Specified by:

graph in interface VertexProperty<V>

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: VertexProperty

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

Specified by:

label in interface Element

Specified by:

label in interface VertexProperty<V>

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

element

public Vertex element()

Description copied from interface: VertexProperty

Gets the Vertex that owns this VertexProperty.

Specified by:

element in interface Property<V>

Specified by:

element in interface VertexProperty<V>

Returns:

The element associated with this property (i.e. Vertex, Edge, or VertexProperty).

iterators

public VertexProperty.Iterators iterators()

Description copied from interface: VertexProperty

Gets the VertexProperty.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 Element

Specified by:

iterators in interface VertexProperty<V>

property

public <U> Property<U> property(java.lang.String key,
                                U value)

Description copied from interface: Element

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

Specified by:

property in interface Element

key

public java.lang.String key()

Description copied from interface: Property

The key of the property.

Specified by:

key in interface Property<V>

Returns:

The property key

value

public V value()
        throws java.util.NoSuchElementException

Description copied from interface: Property

The value of the property.

Specified by:

value in interface Property<V>

Returns:

The property value

Throws:

java.util.NoSuchElementException - thrown if the property is empty

isPresent

public boolean isPresent()

Description copied from interface: Property

Whether the property is empty or not.

Specified by:

isPresent in interface Property<V>

Returns:

True if the property exists, else false

remove

public void remove()

Description copied from interface: Property

Remove the property from the associated element.

Specified by:

remove in interface Element

Specified by:

remove in interface Property<V>

getBaseVertexProperty

public VertexProperty<V> getBaseVertexProperty()

Specified by:

getBaseVertexProperty in interface WrappedVertexProperty<VertexProperty<V>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

propertyIterator

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

Description copied from interface: VertexProperty.Iterators

Get an Iterator of properties.

Specified by:

propertyIterator in interface Element.Iterators

Specified by:

propertyIterator in interface VertexProperty.Iterators

valueIterator

public <U> java.util.Iterator<U> 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