net.ontopia.persistence.proxy
Class TrackableSet

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<E>
          java.util.HashSet
              net.ontopia.persistence.proxy.TrackableSet

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, Set, TrackableCollectionIF

public class TrackableSet
extends HashSet
implements TrackableCollectionIF

INTERNAL: A set implementation that track the changes performed on it. It keeps track of the objects that have been added and the ones that has been removed.

See Also:

Serialized Form

Field Summary

protected Set	added
protected Set	removed
protected TransactionIF	txn

Constructor Summary

TrackableSet(TransactionIF txn, Collection coll)

Method Summary

boolean	add(Object o)
boolean	addAll(Collection c)
boolean	addWithTracking(Object _o) INTERNAL: Adds the item to the collection tracking the change.
void	clear()
void	clearWithTracking() INTERNAL: Removes all items from the collection tracking the changes.
boolean	contains(Object o)
boolean	containsAll(Collection c)
void	dump()
Collection	getAdded() INTERNAL: Gets the objects that have been added to the set.
Collection	getRemoved() INTERNAL: Gets the objects that have been removed from the set.
Iterator	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	removeWithTracking(Object _o) INTERNAL: Removes the item from the collection tracking the change.
void	resetTracking() INTERNAL: Clears the list of added and removed objects without touching the original collection.
boolean	retainAll(Collection c)
void	selfAdded() INTERNAL: Consider existing collection elements as having just been added.
Object[]	toArray()
Object[]	toArray(Object[] a)

Methods inherited from class java.util.HashSet

clone, isEmpty, size

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty, size

Methods inherited from interface java.util.Set

equals, hashCode

Field Detail

txn

protected TransactionIF txn

added

protected Set added

removed

protected Set removed

Constructor Detail

TrackableSet

public TrackableSet(TransactionIF txn,
                    Collection coll)

Method Detail

dump

public void dump()

resetTracking

public void resetTracking()

Description copied from interface: TrackableCollectionIF

INTERNAL: Clears the list of added and removed objects without touching the original collection.

Specified by:

resetTracking in interface TrackableCollectionIF

selfAdded

public void selfAdded()

Description copied from interface: TrackableCollectionIF

INTERNAL: Consider existing collection elements as having just been added.

Specified by:

selfAdded in interface TrackableCollectionIF

getAdded

public Collection getAdded()

Description copied from interface: TrackableCollectionIF

INTERNAL: Gets the objects that have been added to the set. This collection is immutable. Null is returned if the added collection has not been initialized, ie. it is empty.

Specified by:

getAdded in interface TrackableCollectionIF

getRemoved

public Collection getRemoved()

Description copied from interface: TrackableCollectionIF

INTERNAL: Gets the objects that have been removed from the set. This collection is immutable. Null is returned if the removed collection has not been initialized, ie. it is empty.

Specified by:

getRemoved in interface TrackableCollectionIF

addWithTracking

public boolean addWithTracking(Object _o)

Description copied from interface: TrackableCollectionIF

INTERNAL: Adds the item to the collection tracking the change.

Specified by:

addWithTracking in interface TrackableCollectionIF

removeWithTracking

public boolean removeWithTracking(Object _o)

Description copied from interface: TrackableCollectionIF

INTERNAL: Removes the item from the collection tracking the change.

Specified by:

removeWithTracking in interface TrackableCollectionIF

clearWithTracking

public void clearWithTracking()

Description copied from interface: TrackableCollectionIF

INTERNAL: Removes all items from the collection tracking the changes.

Specified by:

clearWithTracking in interface TrackableCollectionIF

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface Set

Overrides:

clear in class HashSet

add

public boolean add(Object o)

Specified by:

add in interface Collection

Specified by:

add in interface Set

Overrides:

add in class HashSet

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface Set

Overrides:

addAll in class AbstractCollection

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection

Specified by:

remove in interface Set

Overrides:

remove in class HashSet

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface Set

Overrides:

removeAll in class AbstractSet

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface Set

Overrides:

retainAll in class AbstractCollection

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Set

Overrides:

iterator in class HashSet

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection

Specified by:

contains in interface Set

Overrides:

contains in class HashSet

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface Set

Overrides:

containsAll in class AbstractCollection

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

Overrides:

toArray in class AbstractCollection

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

Overrides:

toArray in class AbstractCollection