com.tinkerpop.blueprints.util.wrappers.id

Class IdVertex

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.id.IdElement

com.tinkerpop.blueprints.util.wrappers.id.IdVertex

All Implemented Interfaces:

Element, Vertex

public class IdVertex
extends IdElement
implements Vertex

Author:

Joshua Shinavier (http://fortytwo.net)

Field Summary

Fields inherited from class com.tinkerpop.blueprints.util.wrappers.id.IdElement

baseElement, idGraph, propertyBased

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdVertex(Vertex baseVertex, IdGraph idGraph)

Method Summary

Methods

Modifier and Type	Method and Description
Edge	addEdge(String label, Vertex vertex) Add a new outgoing edge from this vertex to the parameter vertex with provided edge label.
Vertex	getBaseVertex()
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.
void	setProperty(String key, Object value) Assign a key/value property to the element.
String	toString()

Methods inherited from class com.tinkerpop.blueprints.util.wrappers.id.IdElement

equals, getId, getProperty, getPropertyKeys, hashCode, remove, removeProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.blueprints.Element

getId, getProperty, getPropertyKeys, remove, removeProperty

Constructor Detail

IdVertex

protected IdVertex(Vertex baseVertex,
        IdGraph idGraph)

Method Detail

getBaseVertex

public Vertex getBaseVertex()

getEdges

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

Description copied from interface: Vertex

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

Specified by:

getEdges in interface Vertex

Parameters:

direction - the direction of the edges to retrieve

labels - the labels of the edges to retrieve

Returns:

an iterable of incident edges

getVertices

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

Description copied from interface: Vertex

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

Specified by:

getVertices in interface Vertex

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

public VertexQuery query()

Description copied from interface: Vertex

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

Specified by:

query in interface Vertex

Returns:

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

setProperty

public void setProperty(String key,
               Object value)

Description copied from interface: Element

Assign a key/value property to the element. If a value already exists for this key, then the previous key/value is overwritten.

Specified by:

setProperty in interface Element

Overrides:

setProperty in class IdElement

Parameters:

key - the string key of the property

value - the object value o the property

addEdge

public Edge addEdge(String label,
           Vertex vertex)

Description copied from interface: Vertex

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

Specified by:

addEdge in interface Vertex

Parameters:

label - the label of the edge

vertex - the vertex to connect to with an incoming edge

Returns:

the newly created edge

toString

public String toString()

Overrides:

toString in class Object