com.tinkerpop.gremlin.structure

Interface Element

All Known Subinterfaces:

Edge, Vertex, VertexProperty<V>

All Known Implementing Classes:

DetachedEdge, DetachedElement, DetachedVertex, DetachedVertexProperty, EmptyVertexProperty, StrategyEdge, StrategyElement, StrategyVertex, StrategyVertexProperty

public interface Element

An Element is the base class for both Vertex and Edge. An Element has an identifier that must be unique to its inheriting classes (Vertex or Edge). An Element can maintain a collection of Property objects. Typically, objects are Java primitives (e.g. String, long, int, boolean, etc.)

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Element.Exceptions Common exceptions to use with an element.
static interface	Element.Iterators An interface that provides access to iterators over properties of an Element, without constructing a Traversal object.

Method Summary

Modifier and Type	Method and Description
Graph	graph() Get the graph that this element is within.
java.lang.Object	id() Gets the unique identifier for the graph Element.
Element.Iterators	iterators() Gets the iterators for the Element.
default 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.
default <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.
void	remove() Removes the Element from the graph.
default <V> V	value(java.lang.String key) Get the value of a Property given it's key.

Method Detail

id

java.lang.Object id()

Gets the unique identifier for the graph Element.

Returns:

The id of the element

label

java.lang.String label()

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

Returns:

The label of the element

graph

Graph graph()

Get the graph that this element is within.

Returns:

the graph of this element

keys

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

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

Returns:

The property key set

property

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

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

property

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

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

value

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

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

Throws:

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

remove

void remove()

Removes the Element from the graph.

iterators

Element.Iterators iterators()

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.