Package org.apache.tinkerpop.gremlin.structure

Interface Element

All Known Subinterfaces:

Edge, Vertex, VertexProperty<V>

All Known Implementing Classes:

ComputerGraph.ComputerAdjacentVertex, ComputerGraph.ComputerEdge, ComputerGraph.ComputerElement, ComputerGraph.ComputerVertex, ComputerGraph.ComputerVertexProperty, DetachedEdge, DetachedElement, DetachedVertex, DetachedVertexProperty, EmptyVertexProperty, KeyedVertexProperty, ReferenceEdge, ReferenceElement, ReferenceVertex, ReferenceVertexProperty, StarGraph.StarAdjacentVertex, StarGraph.StarEdge, StarGraph.StarElement, StarGraph.StarInEdge, StarGraph.StarOutEdge, StarGraph.StarVertex, StarGraph.StarVertexProperty, TinkerEdge, TinkerElement, TinkerVertex, TinkerVertexProperty

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	Description
static class	Element.Exceptions	Common exceptions to use with an element.

Method Summary

Modifier and Type	Method	Description
Graph	graph()	Get the graph that this element is within.
Object	id()	Gets the unique identifier for the graph Element.
default Set<String>	keys()	Get the keys of the properties associated with this element.
String	label()	Gets the label for the graph Element which helps categorize it.
<V> Iterator<? extends Property<V>>	properties(String... propertyKeys)	Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys.
default <V> Property<V>	property(String key)	Get a Property for the Element given its key.
<V> Property<V>	property(String key, V value)	Add or set a property value for the Element given its key.
default <V> Map<String,List<Property<V>>>	propertyMap(String... propertyKeys)	Groups this element's properties by key, preserving encounter order.
void	remove()	Removes the Element from the graph.
default <V> V	value(String key)	Get the value of a Property given it's key.
default <V> Iterator<V>	values(String... propertyKeys)	Get the values of properties as an Iterator.

Method Detail

id

Object id()

Gets the unique identifier for the graph Element.

Returns:

The id of the element

label

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 Set<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(String key)

Get a Property for the Element given its key. The default implementation calls the raw properties(java.lang.String...).

property

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

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

value

default <V> V value(String key)
             throws 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:

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

remove

void remove()

Removes the Element from the graph.

values

default <V> Iterator<V> values(String... propertyKeys)

Get the values of properties as an Iterator.

properties

<V> Iterator<? extends Property<V>> properties(String... propertyKeys)

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.

propertyMap

default <V> Map<String,List<Property<V>>> propertyMap(String... propertyKeys)

Groups this element's properties by key, preserving encounter order. A Vertex multi-property key maps to several Property objects; otherwise each key maps to a single-element list. Empty map when there are no matching properties.

Parameters:

propertyKeys - the keys to filter on; if none are provided then all properties are grouped

Returns:

a map of property key to the list of properties for that key