com.tinkerpop.blueprints.util.wrappers.readonly

Class ReadOnlyVertex

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyVertex

All Implemented Interfaces:

Element, Vertex

public class ReadOnlyVertex
extends Object
implements Vertex

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	baseElement

Constructor Summary

Constructors

Constructor and Description
ReadOnlyVertex(Vertex baseVertex)

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.
boolean	equals(Object object)
Iterable<Edge>	getEdges(Direction direction, String... labels) Return the edges incident to the vertex according to the provided direction and edge labels.
Object	getId() An identifier that is unique to its inheriting class.
<T> T	getProperty(String key) Return the object value associated with the provided string key.
Set<String>	getPropertyKeys() Return all the keys associated with the element.
Iterable<Vertex>	getVertices(Direction direction, String... labels) Return the vertices adjacent to the vertex according to the provided direction and edge labels.
int	hashCode()
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	remove() Remove the element from the graph.
Object	removeProperty(String key) Un-assigns a key/value property from the element.
void	setProperty(String key, Object value) Assign a key/value property to the element.
String	toString()

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, setProperty

Field Detail

baseElement

protected final Element baseElement

Constructor Detail

ReadOnlyVertex

public ReadOnlyVertex(Vertex baseVertex)

Method Detail

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

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

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

getPropertyKeys

public Set<String> getPropertyKeys()

Description copied from interface: Element

Return all the keys associated with the element.

Specified by:

getPropertyKeys in interface Element

Returns:

the set of all string keys associated with the element

getId

public Object getId()

Description copied from interface: Element

An identifier that is unique to its inheriting class. All vertices of a graph must have unique identifiers. All edges of a graph must have unique identifiers.

Specified by:

getId in interface Element

Returns:

the identifier of the element

removeProperty

public Object removeProperty(String key)
                      throws UnsupportedOperationException

Description copied from interface: Element

Un-assigns a key/value property from the element. The object value of the removed property is returned.

Specified by:

removeProperty in interface Element

Parameters:

key - the key of the property to remove from the element

Returns:

the object value associated with that key prior to removal

Throws:

UnsupportedOperationException

getProperty

public <T> T getProperty(String key)

Description copied from interface: Element

Return the object value associated with the provided string key. If no value exists for that key, return null.

Specified by:

getProperty in interface Element

Parameters:

key - the key of the key/value property

Returns:

the object value related to the string key

setProperty

public void setProperty(String key,
               Object value)
                 throws UnsupportedOperationException

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

Parameters:

key - the string key of the property

value - the object value o the property

Throws:

UnsupportedOperationException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

remove

public void remove()

Description copied from interface: Element

Remove the element from the graph.

Specified by:

remove in interface Element

equals

public boolean equals(Object object)

Overrides:

equals in class Object