ojb.broker
Interface ManageableCollection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArticleCollection, CollectionProxy, DListImpl, ManageableArrayList, ManageableHashSet, ManageableVector

public interface ManageableCollection

extends java.io.Serializable

OJB can handle java.util.Collection as well as user defined collection classes as collection attributes in persistent classes. In order to collaborate with the OJB mechanisms these collection must provide a minimum protocol as defined by this interface ManageableCollection. The methods have a prefix "ojb" that indicates that these methods are "technical" methods, required by OJB and not to be used in business code.

Method Summary

void	ojbAdd(java.lang.Object anObject) add a single Object to the Collection.
void	ojbAddAll(ManageableCollection otherCollection) adds a Collection to this collection.
java.util.Iterator	ojbIterator() returns an Iterator over all elements in the collection.

Method Detail

ojbAdd

public void ojbAdd(java.lang.Object anObject)

add a single Object to the Collection. This method is used during reading Collection elements from the database. Thus it is is save to cast anObject to the underlying element type of the collection.

ojbAddAll

public void ojbAddAll(ManageableCollection otherCollection)

adds a Collection to this collection. Used in reading Extents from the Database. Thus it is save to cast otherCollection to this.getClass().

ojbIterator

public java.util.Iterator ojbIterator()

returns an Iterator over all elements in the collection. Used during store and delete Operations. If the implementor does not return an iterator over ALL elements, OJB cannot store and delete all elements properly.