com.tinkerpop.blueprints.util.wrappers.event

Class EventElement

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.event.EventElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

EventEdge, EventVertex

public abstract class EventElement
extends Object
implements Element

An element with a GraphChangedListener attached. Those listeners are notified when changes occur to the properties of the element.

Author:

Stephen Mallette

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	baseElement
protected EventGraph	eventGraph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventElement(Element baseElement, EventGraph eventGraph)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
Element	getBaseElement()
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()
protected void	onEdgePropertyChanged(Edge edge, String key, Object oldValue, Object newValue)
protected void	onEdgePropertyRemoved(Edge edge, String key, Object removedValue)
protected void	onVertexPropertyChanged(Vertex vertex, String key, Object oldValue, Object newValue)
protected void	onVertexPropertyRemoved(Vertex vertex, String key, Object removedValue)
void	remove() Remove the element from the graph.
<T> T	removeProperty(String key) Raises a vertexPropertyRemoved or edgePropertyRemoved event.
void	setProperty(String key, Object value) Raises a vertexPropertyRemoved or edgePropertyChanged event.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

eventGraph

protected final EventGraph eventGraph

baseElement

protected final Element baseElement

Constructor Detail

EventElement

protected EventElement(Element baseElement,
            EventGraph eventGraph)

Method Detail

onVertexPropertyChanged

protected void onVertexPropertyChanged(Vertex vertex,
                           String key,
                           Object oldValue,
                           Object newValue)

onEdgePropertyChanged

protected void onEdgePropertyChanged(Edge edge,
                         String key,
                         Object oldValue,
                         Object newValue)

onVertexPropertyRemoved

protected void onVertexPropertyRemoved(Vertex vertex,
                           String key,
                           Object removedValue)

onEdgePropertyRemoved

protected void onEdgePropertyRemoved(Edge edge,
                         String key,
                         Object removedValue)

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 <T> T removeProperty(String key)

Raises a vertexPropertyRemoved or edgePropertyRemoved event.

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

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)

Raises a vertexPropertyRemoved or edgePropertyChanged event.

Specified by:

setProperty in interface Element

Parameters:

key - the string key of the property

value - the object value o the property

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getBaseElement

public Element getBaseElement()

remove

public void remove()

Description copied from interface: Element

Remove the element from the graph.

Specified by:

remove in interface Element