View Javadoc
1 package org.apache.torque.oid; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * 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, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 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 APACHE SOFTWARE FOUNDATION 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 on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>. 55 */ 56 57 import java.sql.Connection; 58 import java.math.BigDecimal; 59 60 /*** 61 * Interface to be implemented by id generators. It is possible 62 * that some implementations might not require all the arguments, 63 * for example MySQL will not require a keyInfo Object, while the 64 * IDBroker implementation does not require a Connection as 65 * it only rarely needs one and retrieves a connection from the 66 * Connection pool service only when needed. 67 * 68 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a> 69 * @version $Id: IdGenerator.java,v 1.7 2002/05/07 17:13:22 mpoeschl Exp $ 70 */ 71 public interface IdGenerator 72 { 73 /*** 74 * Returns an id as a primitive int. If you use numeric 75 * identifiers, it's suggested that {@link 76 * #getIdAsLong(Connection, Object)} be used instead (due to the 77 * limitted range of this method). 78 * 79 * @param connection A Connection. 80 * @param keyInfo an Object that contains additional info. 81 * @return An int with the value for the id. 82 * @exception Exception Database error. 83 */ 84 int getIdAsInt(Connection connection, Object keyInfo) 85 throws Exception; 86 87 /*** 88 * Returns an id as a primitive long. 89 * 90 * @param connection A Connection. 91 * @param keyInfo an Object that contains additional info. 92 * @return A long with the value for the id. 93 * @exception Exception Database error. 94 */ 95 long getIdAsLong(Connection connection, Object keyInfo) 96 throws Exception; 97 98 /*** 99 * Returns an id as a BigDecimal. 100 * 101 * @param connection A Connection. 102 * @param keyInfo an Object that contains additional info. 103 * @return A BigDecimal id. 104 * @exception Exception Database error. 105 */ 106 BigDecimal getIdAsBigDecimal(Connection connection, Object keyInfo) 107 throws Exception; 108 109 /*** 110 * Returns an id as a String. 111 * 112 * @param connection A Connection. 113 * @param keyInfo an Object that contains additional info. 114 * @return A String id 115 * @exception Exception Database error. 116 */ 117 String getIdAsString(Connection connection, Object keyInfo) 118 throws Exception; 119 120 /*** 121 * A flag to determine the timing of the id generation 122 * 123 * @return a <code>boolean</code> value 124 */ 125 boolean isPriorToInsert(); 126 127 /*** 128 * A flag to determine the timing of the id generation 129 * 130 * @return Whether id is availble post-<code>insert</code>. 131 */ 132 boolean isPostInsert(); 133 134 /*** 135 * A flag to determine whether a Connection is required to 136 * generate an id. 137 * 138 * @return a <code>boolean</code> value 139 */ 140 boolean isConnectionRequired(); 141 }

This page was automatically generated by Maven