PkGenerator


1   /* ====================================================================
2    *
3    * The ObjectStyle Group Software License, version 1.1
4    * ObjectStyle Group - http://objectstyle.org/
5    * 
6    * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7    * of the software. All rights reserved.
8    * 
9    * Redistribution and use in source and binary forms, with or without
10   * modification, are permitted provided that the following conditions
11   * are met:
12   * 
13   * 1. Redistributions of source code must retain the above copyright
14   *    notice, this list of conditions and the following disclaimer.
15   * 
16   * 2. Redistributions in binary form must reproduce the above copyright
17   *    notice, this list of conditions and the following disclaimer in
18   *    the documentation and/or other materials provided with the
19   *    distribution.
20   * 
21   * 3. The end-user documentation included with the redistribution, if any,
22   *    must include the following acknowlegement:
23   *    "This product includes software developed by independent contributors
24   *    and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25   *    Alternately, this acknowlegement may appear in the software itself,
26   *    if and wherever such third-party acknowlegements normally appear.
27   * 
28   * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29   *    or promote products derived from this software without prior written
30   *    permission. For written permission, email
31   *    "andrus at objectstyle dot org".
32   * 
33   * 5. Products derived from this software may not be called "ObjectStyle"
34   *    or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35   *    names without prior written permission.
36   * 
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48   * SUCH DAMAGE.
49   * ====================================================================
50   * 
51   * This software consists of voluntary contributions made by many
52   * individuals and hosted on ObjectStyle Group web site.  For more
53   * information on the ObjectStyle Group, please see
54   * <http://objectstyle.org/>.
55   */
56  
57  package org.objectstyle.cayenne.dba;
58  
59  import java.util.List  ;
60  
61  import org.objectstyle.cayenne.access.DataNode;
62  import org.objectstyle.cayenne.map.DbEntity;
63  
64  /**
65   * Defines methods to support automatic primary key generation.
66   * 
67   * @author Andrei Adamchik
68   */
69  public interface PkGenerator {
70  
71      /**
72       * Generates necessary database objects to provide automatic primary key support.
73       * 
74       * @param node node that provides access to a DataSource.
75       * @param dbEntities a list of entities that require primary key autogeneration
76       *            support
77       */
78      void createAutoPk(DataNode node, List   dbEntities) throws Exception  ;
79  
80      /**
81       * Returns a list of SQL strings needed to generates database objects to provide
82       * automatic primary support for the list of entities. No actual database operations
83       * are performed.
84       */
85      List   createAutoPkStatements(List   dbEntities);
86  
87      /**
88       * Drops any common database objects associated with automatic primary key generation
89       * process. This may be lookup tables, special stored procedures or sequences.
90       * 
91       * @param node node that provides access to a DataSource.
92       * @param dbEntities a list of entities whose primary key autogeneration support
93       *            should be dropped.
94       */
95      void dropAutoPk(DataNode node, List   dbEntities) throws Exception  ;
96  
97      /**
98       * Returns SQL string needed to drop database objects associated with automatic
99       * primary key generation. No actual database operations are performed.
100      */
101     List   dropAutoPkStatements(List   dbEntities);
102 
103     /**
104      * Generates new (unique and non-repeating) primary key for specified DbEntity.
105      * 
106      * @param ent DbEntity for which automatic PK is generated.
107      */
108     Object   generatePkForDbEntity(DataNode dataNode, DbEntity ent) throws Exception  ;
109 
110     /**
111      * Returns SQL string that can generate new (unique and non-repeating) primary key for
112      * specified DbEntity. No actual database operations are performed.
113      * 
114      * @deprecated Since 1.2. This method is not used.
115      */
116     String   generatePkForDbEntityString(DbEntity ent);
117 
118     /**
119      * Resets any cached primary keys forcing generator to go to the database next time id
120      * generation is requested. May not be applicable for all generator implementations.
121      */
122     void reset();
123 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags