com.tinkerpop.gremlin.structure

Interface Vertex

All Superinterfaces:

Element, ElementTraversal<Vertex>, VertexTraversal

All Known Implementing Classes:

DetachedVertex, StrategyVertex

public interface Vertex
extends Element, VertexTraversal

A Vertex maintains pointers to both a set of incoming and outgoing Edge objects. The outgoing edges are those edges for which the Vertex is the tail. The incoming edges are those edges for which the Vertex is the head.

Diagrammatically:

 ---inEdges---> vertex ---outEdges--->.
 

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	Vertex.Exceptions Common exceptions to use with a vertex.
static interface	Vertex.Iterators An interface that provides access to iterators over VertexProperty objects, Edge objects and adjacent vertices, associated with the Vertex, without constructing a Traversal object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LABEL The default label to use for a vertex.

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.
Vertex.Iterators	iterators() Get the Vertex.Iterators implementation associated with this Vertex.
default <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.
default <V> VertexProperty<V>	property(java.lang.String key, V value, java.lang.Object... keyValues)
default <V> VertexProperty<V>	singleProperty(java.lang.String key, V value, java.lang.Object... keyValues)

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

graph, id, keys, label, remove, value

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

Field Detail

DEFAULT_LABEL

static final java.lang.String DEFAULT_LABEL

The default label to use for a vertex.

See Also:

Constant Field Values

Method Detail

addEdge

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

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

default <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

property

<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

property

default <V> VertexProperty<V> property(java.lang.String key,
                                       V value,
                                       java.lang.Object... keyValues)

singleProperty

default <V> VertexProperty<V> singleProperty(java.lang.String key,
                                             V value,
                                             java.lang.Object... keyValues)

iterators

Vertex.Iterators iterators()

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