org.apache.tinkerpop.gremlin.hadoop.structure

Class HadoopVertex

java.lang.Object

org.apache.tinkerpop.gremlin.hadoop.structure.HadoopElement

org.apache.tinkerpop.gremlin.hadoop.structure.HadoopVertex

All Implemented Interfaces:

Element, Host, WrappedVertex<Vertex>, Vertex

public final class HadoopVertex
extends HadoopElement
implements Vertex, WrappedVertex<Vertex>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

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

Vertex.Exceptions

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.hadoop.structure.HadoopElement

baseElement, graph

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Vertex

DEFAULT_LABEL, EMPTY_ARGS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HadoopVertex()
	HadoopVertex(Vertex vertex, HadoopGraph graph)

Method Summary

Modifier and Type	Method and Description
Edge	addEdge(String label, Vertex inVertex, Object... keyValues) Add an outgoing edge to the vertex with provided label and edge properties as key/value pairs.
Iterator<Edge>	edges(Direction direction, String... edgeLabels) Gets an Iterator of incident edges.
Vertex	getBaseVertex()
<V> Iterator<VertexProperty<V>>	properties(String... propertyKeys) Get an Iterator of properties.
<V> VertexProperty<V>	property(String key) Get a Property for the Element given its key.
<V> VertexProperty<V>	property(String key, V value) Add or set a property value for the Element given its key.
<V> VertexProperty<V>	property(String key, V value, Object... keyValues) Set the provided key to the provided value using default VertexProperty.Cardinality for that key.
<V> VertexProperty<V>	property(VertexProperty.Cardinality cardinality, String key, V value, Object... keyValues) Create a new vertex property.
Iterator<Vertex>	vertices(Direction direction, String... edgeLabels) Gets an Iterator of adjacent vertices.

Methods inherited from class org.apache.tinkerpop.gremlin.hadoop.structure.HadoopElement

equals, graph, hashCode, id, label, remove, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element

graph, id, keys, label, remove, value, values

Constructor Detail

HadoopVertex

protected HadoopVertex()

HadoopVertex

public HadoopVertex(Vertex vertex,
                    HadoopGraph graph)

Method Detail

property

public <V> VertexProperty<V> property(String key)

Description copied from interface: Element

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

Specified by:

property in interface Element

Specified by:

property in interface Vertex

Overrides:

property in class HadoopElement

Type Parameters:

V - the expected type of the vertex property value

Parameters:

key - the key of the vertex property to get

Returns:

the retrieved vertex property

property

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

Overrides:

property in class HadoopElement

Type Parameters:

V - the type of the value of the vertex property

Parameters:

key - the key of the vertex property

value - The value of the vertex property

Returns:

the newly created vertex property

property

public <V> VertexProperty<V> property(String key,
                                      V value,
                                      Object... keyValues)

Description copied from interface: Vertex

Set the provided key to the provided value using default VertexProperty.Cardinality for that key. The default cardinality can be vendor defined and is usually tied to the graph schema. The default implementation of this method determines the cardinality graph().features().vertex().getCardinality(key). The provided key/values are the properties of the newly created VertexProperty. These key/values must be provided in an even number where the odd numbered arguments are String.

Specified by:

property in interface Vertex

Type Parameters:

V - the type of the value of the vertex property

Parameters:

key - the key of the vertex property

value - The value of the vertex property

keyValues - the key/value pairs to turn into vertex property properties

Returns:

the newly created vertex property

property

public <V> VertexProperty<V> property(VertexProperty.Cardinality cardinality,
                                      String key,
                                      V value,
                                      Object... keyValues)

Description copied from interface: Vertex

Create a new vertex property. If the cardinality is VertexProperty.Cardinality.single, then set the key to the value. If the cardinality is VertexProperty.Cardinality.list, then add a new value to the key. If the cardinality is VertexProperty.Cardinality.set, then only add a new value if that value doesn't already exist for the key. If the value already exists for the key, add the provided key value vertex property properties to it.

Specified by:

property in interface Vertex

Type Parameters:

V - the type of the value of the vertex property

Parameters:

cardinality - the desired cardinality of the property key

key - the key of the vertex property

value - The value of the vertex property

keyValues - the key/value pairs to turn into vertex property properties

Returns:

the newly created vertex property

addEdge

public Edge addEdge(String label,
                    Vertex inVertex,
                    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

getBaseVertex

public Vertex getBaseVertex()

Specified by:

getBaseVertex in interface WrappedVertex<Vertex>

vertices

public Iterator<Vertex> vertices(Direction direction,
                                 String... edgeLabels)

Description copied from interface: Vertex

Gets an Iterator of adjacent vertices.

Specified by:

vertices in interface Vertex

Parameters:

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

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

edges

public Iterator<Edge> edges(Direction direction,
                            String... edgeLabels)

Description copied from interface: Vertex

Gets an Iterator of incident edges.

Specified by:

edges in interface Vertex

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

properties

public <V> Iterator<VertexProperty<V>> properties(String... propertyKeys)

Description copied from interface: Vertex

Get an Iterator of properties.

Specified by:

properties in interface Element

Specified by:

properties in interface Vertex