org.apache.clerezza.implementation.graph

Class WatchableGraphWrapper

java.lang.Object

org.apache.clerezza.implementation.graph.WatchableGraphWrapper

All Implemented Interfaces:

Iterable<Triple>, Collection<Triple>, Graph, WatchableGraph

public class WatchableGraphWrapper
extends Object
implements WatchableGraph

Author:

developer

Constructor Summary

Constructors

Constructor and Description
WatchableGraphWrapper(Graph wrapped)

Method Summary

Modifier and Type	Method and Description
boolean	add(Triple triple)
boolean	addAll(Collection<? extends Triple> c)
void	addGraphListener(GraphListener listener, FilterTriple filter) Adds the specified GraphListener to the graph.
void	addGraphListener(GraphListener listener, FilterTriple filter, long delay) Adds the specified GraphListener to the graph.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
protected void	dispatchEvent(GraphEvent event) Dispatches a GraphEvent to all registered listeners for which the specified Triple matches the FilterTriples of the listeners.
Iterator<Triple>	filter(BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Filters triples given a pattern.
ImmutableGraph	getImmutableGraph() Returns an ImutableGraph describing the graph at the current point in time.
ReadWriteLock	getLock() The lock provided by this methods allows to create read- and write-locks that span multiple method calls.
boolean	isEmpty()
Iterator<Triple>	iterator()
protected boolean	performAdd(Triple e) A subclass of AbstractGraph should override this method instead of add for Graph event support to be added.
protected boolean	performRemove(Triple triple) A subclass of AbstractGraph should override this method instead of remove for ImmutableGraph event support to be added.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
void	removeGraphListener(GraphListener listener) Removes the specified GraphListener from the graph.
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.clerezza.Graph

equals

Methods inherited from interface java.util.Collection

hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

WatchableGraphWrapper

public WatchableGraphWrapper(Graph wrapped)

Method Detail

iterator

public Iterator<Triple> iterator()

Specified by:

iterator in interface Iterable<Triple>

Specified by:

iterator in interface Collection<Triple>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Triple>

filter

public Iterator<Triple> filter(BlankNodeOrIRI subject,
                               IRI predicate,
                               RDFTerm object)

Description copied from interface: Graph

Filters triples given a pattern. filter(null, null, null) returns the same as iterator()

Specified by:

filter in interface Graph

Returns:

Iterator

add

public boolean add(Triple triple)

Specified by:

add in interface Collection<Triple>

performAdd

protected boolean performAdd(Triple e)

A subclass of AbstractGraph should override this method instead of add for Graph event support to be added.

Parameters:

e - The triple to be added to the triple collection

Returns:

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Triple>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<Triple>

performRemove

protected boolean performRemove(Triple triple)

A subclass of AbstractGraph should override this method instead of remove for ImmutableGraph event support to be added.

Parameters:

o - The triple to be removed from the triple collection

Returns:

dispatchEvent

protected void dispatchEvent(GraphEvent event)

Dispatches a GraphEvent to all registered listeners for which the specified Triple matches the FilterTriples of the listeners.

Parameters:

triple - The Triple that was modified

type - The type of modification

addGraphListener

public void addGraphListener(GraphListener listener,
                             FilterTriple filter)

Description copied from interface: WatchableGraph

Adds the specified GraphListener to the graph. This listener will be notified, when the graph is modified and the Triple that was part of the modifiaction matched the specified FilterTriple. The notification will be passed without delay.

Same as addGraphListener(listener, filter, 0).

Specified by:

addGraphListener in interface WatchableGraph

Parameters:

listener - The listener that will be notified

filter - The triple filter with which triples are tested, that were part of the modification.

addGraphListener

public void addGraphListener(GraphListener listener,
                             FilterTriple filter,
                             long delay)

Description copied from interface: WatchableGraph

Adds the specified GraphListener to the graph. This listener will be notified, when the graph is modified and the Triple that was part of the modifiaction matched the specified FilterTriple. The notification will be passed to the listener after the specified delay time (in milli-seconds) has passed. If more matching events occur during the delay period, then they are passed all together at the end of the delay period. If the the listener unregisters or the platform is stopped within the period then the already occurred events may not be delivered.

All implementations support this method, immutable implementations will typically provide an empty implementation, they shall not throw an exception.

Implementation of which the triples change over time without add- and remove-methods being called (e.g. implementation dynamically generating their triples on invocation of the filer-method) may choose not to, or only partially propagate their changes to the listener. They should describe the behavior in the documentation of the class.

Implementations should keep weak references the listeners, so that the listener can be garbage collected if its no longer referenced by another object.

If delay is 0 notification will happen synchroneously.

Specified by:

addGraphListener in interface WatchableGraph

Parameters:

listener - The listener that will be notified

filter - The triple filter with which triples are tested, that were part of the modification.

delay - The time period afer which the listener will be notified in milliseconds.

removeGraphListener

public void removeGraphListener(GraphListener listener)

Description copied from interface: WatchableGraph

Removes the specified GraphListener from the graph. This listener will no longer be notified, when the graph is modified.

Specified by:

removeGraphListener in interface WatchableGraph

Parameters:

listener - The listener to be removed.

getImmutableGraph

public ImmutableGraph getImmutableGraph()

Description copied from interface: Graph

Returns an ImutableGraph describing the graph at the current point in time. if this is an instance of ImmutableGraph this can safely return this.

Specified by:

getImmutableGraph in interface Graph

Returns:

the current time slice of the possibly mutable graph represented by the instance.

getLock

public ReadWriteLock getLock()

Description copied from interface: Graph

The lock provided by this methods allows to create read- and write-locks that span multiple method calls. Having a read locks prevents other threads from writing to this Graph, having a write-lock prevents other threads from reading and writing. Implementations would typically return a java.util.concurrent.locks.ReentrantReadWriteLock. Immutable instances (such as instances of ImmutableGraph) or instances used in transaction where concurrent acces of the same instance is not an issue may return a no-op ReadWriteLock (i.e. one which returned ReadLock and WriteLock instances of which the methods do not do anything)

Specified by:

getLock in interface Graph

Returns:

the lock of this Graph

size

public int size()

Specified by:

size in interface Collection<Triple>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Triple>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Triple>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<Triple>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<Triple>

addAll

public boolean addAll(Collection<? extends Triple> c)

Specified by:

addAll in interface Collection<Triple>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<Triple>

clear

public void clear()

Specified by:

clear in interface Collection<Triple>