KeyGenerator


1   /*
2    * $Id: KeyGenerator.java,v 1.3 2005/06/07 12:32:31 bel70 Exp $
3    *
4    * ***** BEGIN LICENSE BLOCK *****
5    * The contents of this file are subject to the Mozilla Public License
6    * Version 1.1 (the "License"); you may not use this file except in 
7    * compliance with the License. You may obtain a copy of the License 
8    * at http://www.mozilla.org/MPL/
9    *
10   * Software distributed under the License is distributed on an "AS IS"
11   * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
12   * the License for the specific language governing rights and 
13   * limitations under the License.
14   *
15   * The Original Code is JGossip forum code.
16   *
17   * The Initial Developer of the Original Code is the JResearch, Org. 
18   * Portions created by the Initial Developer are Copyright (C) 2004 
19   * the Initial Developer. All Rights Reserved. 
20   * 
21   * Contributor(s): 
22   *              Alexey Pavlov <alexnet@users.sourceforge.net>
23   *        
24   * ***** END LICENSE BLOCK ***** */
25  package org.jresearch.gossip.dao.drivers.keygen;
26  
27  import java.math.BigDecimal  ;
28  import java.sql.Connection  ;
29  import java.sql.SQLException  ;
30  
31  /**
32   * The primarey key generator contract.
33   * 
34   * @author <a HREF="alexnet@sourceforge.net">A. Pavlov</a>
35   * @version $version$ $Date: 2005/06/07 12:32:31 $
36   */
37  public interface KeyGenerator {
38      BigDecimal   ONE = new BigDecimal  (1);
39  
40      /**
41       * This generates a key for a field in the object described by the given
42       * primary key name.
43       * 
44       * @param primaryKeyNames
45       *            provides mapping of class to sql persistence
46       * @param con
47       *            The database for persisting the object described in String[]
48       *            primaryKeyNames
49       * @return Generated primary key.
50       * @exception SQLException
51       *                if an error occurs
52       */
53      Object   generateKey(String  [] primaryKeyName, Connection   connection)
54              throws SQLException  ;
55  
56      /**
57       * @return
58       */
59      boolean isBeforeInsert();
60  
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags