ManageableCollection


1   package org.apache.ojb.broker;
2   
3   /* Copyright 2002-2005 The Apache Software Foundation
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  import java.util.Iterator  ;
19  
20  /**
21   * OJB can handle java.util.Collection as well as user defined collection classes as collection attributes
22   * in persistent classes. In order to collaborate with the OJB mechanisms these collection must provide a minimum
23   * protocol as defined by this interface ManageableCollection.
24   * The methods have a prefix "ojb" that indicates that these methods are "technical" methods, required
25   * by OJB and not to be used in business code.
26   *
27   * @author Thomas Mahler
28   * @version $Id: ManageableCollection.java,v 1.7.2.1 2005/12/21 22:22:08 tomdz Exp $
29   */
30  public interface ManageableCollection extends java.io.Serializable  
31  {
32      /**
33       * Adds a single object to the Collection. This method is used during reading collection elements
34       * from the database. Thus it is safe to cast the object to the underlying element type of the
35       * collection.
36       * 
37       * @param anObject The object to add
38       */
39      void ojbAdd(Object   anObject);
40  
41      /**
42       * Adds another collection to this collection. Used in reading extents from the database.
43       * Thus it is safe to cast the given collection to this class.
44       * 
45       * @param otherCollection The added collection
46       */
47      void ojbAddAll(ManageableCollection otherCollection);
48  
49      /**
50       * Returns an iterator over all elements in the collection. Used during store and delete
51       * operations. If the implementor does not return an iterator over ALL elements, OJB cannot
52       * store and delete all elements properly.
53       *
54       * @return The iterator
55       */
56      Iterator   ojbIterator();
57  
58      /**
59       * A callback method to implement 'removal-aware' (track removed objects and delete
60       * them by its own) collection implementations.
61       * 
62       * @param broker The persistence broker
63       */
64      public void afterStore(PersistenceBroker broker) throws PersistenceBrokerException;
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags