RelationshipPrefetcher


1   package org.apache.ojb.broker.accesslayer;
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.Collection  ;
19  
20  import org.apache.ojb.broker.metadata.ClassDescriptor;
21   
22  /**
23   * Interface for Relationship Prefetchers.
24   * Each Prefetcher handles a single Relationship (1:1 or 1:n)
25   * 
26   * @author <a HREF="mailto:jbraeuchi@gmx.ch">Jakob Braeuchi</a>
27   * @version $Id: RelationshipPrefetcher.java,v 1.5.2.1 2005/12/21 22:22:58 tomdz Exp $
28   */
29  public interface RelationshipPrefetcher
30  {
31      /**
32       * Returns the ClassDescriptor of the item Class
33       * @return ClassDescriptor
34       */
35      public ClassDescriptor getItemClassDescriptor();
36  
37      /**
38       * Prepare the Relationship for prefetch (ie: disable auto-retrieve)
39       */ 
40      public void prepareRelationshipSettings();
41  
42      /**
43       * Prefetch the Relationship for the owners (the 1 side of a 1:n)
44       */ 
45      public void prefetchRelationship(Collection   owners);
46  
47      /**
48       * Restore the Relationship settings(ie: enable auto-retrieve)
49       */ 
50      public void restoreRelationshipSettings();
51  
52      /**
53       * The limit of objects loaded by one SQL query
54       */
55      public int getLimit();
56  }
57
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags