com.tinkerpop.blueprints

Interface Vertex

All Superinterfaces:

Element

All Known Implementing Classes:

EventVertex, IdVertex, PartitionVertex, ReadOnlyVertex, WrappedVertex

public interface Vertex
extends Element

A vertex maintains pointers to both a set of incoming and outgoing edges. 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), Matthias Brocheler (http://matthiasb.com)

Method Summary

Methods

Modifier and Type	Method and Description
Edge	addEdge(String label, Vertex inVertex) Add a new outgoing edge from this vertex to the parameter vertex with provided edge label.
Iterable<Edge>	getEdges(Direction direction, String... labels) Return the edges incident to the vertex according to the provided direction and edge labels.
Iterable<Vertex>	getVertices(Direction direction, String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
VertexQuery	query() Generate a query object that can be used to fine tune which edges/vertices are retrieved that are incident/adjacent to this vertex.

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, remove, removeProperty, setProperty

Method Detail

getEdges

Iterable<Edge> getEdges(Direction direction,
                      String... labels)

Return the edges incident to the vertex according to the provided direction and edge labels.

Parameters:

direction - the direction of the edges to retrieve

labels - the labels of the edges to retrieve

Returns:

an iterable of incident edges

getVertices

Iterable<Vertex> getVertices(Direction direction,
                           String... labels)

Return the vertices adjacent to the vertex according to the provided direction and edge labels. This method does not remove duplicate vertices (i.e. those vertices that are connected by more than one edge).

Parameters:

direction - the direction of the edges of the adjacent vertices

labels - the labels of the edges of the adjacent vertices

Returns:

an iterable of adjacent vertices

query

VertexQuery query()

Generate a query object that can be used to fine tune which edges/vertices are retrieved that are incident/adjacent to this vertex.

Returns:

a vertex query object with methods for constraining which data is pulled from the underlying graph

addEdge

Edge addEdge(String label,
           Vertex inVertex)

Add a new outgoing edge from this vertex to the parameter vertex with provided edge label.

Parameters:

label - the label of the edge

inVertex - the vertex to connect to with an incoming edge

Returns:

the newly created edge