com.tinkerpop.blueprints.util.wrappers.readonly

Class ReadOnlyEdge

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyEdge

All Implemented Interfaces:

Edge, Element

public class ReadOnlyEdge
extends Object
implements Edge

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
ReadOnlyEdge(Edge baseEdge)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
Object	getId() An identifier that is unique to its inheriting class.
String	getLabel() Return the label associated with the edge.
<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.
Vertex	getVertex(Direction direction) Return the tail/out or head/in vertex.
int	hashCode()
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

ReadOnlyEdge

public ReadOnlyEdge(Edge baseEdge)

Method Detail

getVertex

public Vertex getVertex(Direction direction)
                 throws IllegalArgumentException

Description copied from interface: Edge

Return the tail/out or head/in vertex.

Specified by:

getVertex in interface Edge

Parameters:

direction - whether to return the tail/out or head/in vertex

Returns:

the tail/out or head/in vertex

Throws:

IllegalArgumentException - is thrown if a direction of both is provided

getLabel

public String getLabel()

Description copied from interface: Edge

Return the label associated with the edge.

Specified by:

getLabel in interface Edge

Returns:

the edge label

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