com.tinkerpop.blueprints.util.wrappers.id

Class IdElement

java.lang.Object

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

All Implemented Interfaces:

Element

Direct Known Subclasses:

IdEdge, IdVertex

public abstract class IdElement
extends Object
implements Element

Author:

Joshua Shinavier (http://fortytwo.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	baseElement
protected IdGraph	idGraph
protected boolean	propertyBased

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdElement(Element baseElement, IdGraph idGraph, boolean propertyBased)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
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.
int	hashCode()
void	remove() Remove the element from the graph.
<T> T	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.

Methods inherited from class java.lang.Object

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

Field Detail

baseElement

protected final Element baseElement

idGraph

protected final IdGraph idGraph

propertyBased

protected final boolean propertyBased

Constructor Detail

IdElement

protected IdElement(Element baseElement,
         IdGraph idGraph,
         boolean propertyBased)

Method Detail

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

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

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

Parameters:

key - the string key of the property

value - the object value o the property

removeProperty

public <T> T removeProperty(String key)

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

remove

public void remove()

Description copied from interface: Element

Remove the element from the graph.

Specified by:

remove in interface Element