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 org.apache.torque.adapter.DB;
58 import org.apache.torque.adapter.IDMethod;
59
60 /***
61 * A factory which instantiates {@link
62 * org.apache.torque.oid.IdGenerator} implementations.
63 *
64 * @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
65 * @version $Id: IDGeneratorFactory.java,v 1.2 2002/11/26 23:46:56 mpoeschl Exp $
66 */
67 public class IDGeneratorFactory
68 {
69 /***
70 * The list of ID generation method types which have associated
71 * {@link org.apache.torque.oid.IdGenerator} implementations.
72 */
73 public static final String[] ID_GENERATOR_METHODS =
74 {
75 IDMethod.NATIVE, IDMethod.AUTO_INCREMENT, IDMethod.SEQUENCE
76 };
77
78 /***
79 * Factory method which instantiates {@link
80 * org.apache.torque.oid.IdGenerator} implementations based on the
81 * return value of the provided adapter's {@link
82 * org.apache.torque.adapter.DB#getIDMethodType()} method.
83 * Returns <code>null</code> for unknown types.
84 *
85 * @param dbAdapter The type of adapter to create an ID generator for.
86 * @return The appropriate ID generator (possibly <code>null</code>).
87 */
88 public static IdGenerator create(DB dbAdapter)
89 {
90 String idMethod = dbAdapter.getIDMethodType();
91 if (IDMethod.AUTO_INCREMENT.equals(idMethod))
92 {
93 return new AutoIncrementIdGenerator(dbAdapter);
94 }
95 else if (IDMethod.SEQUENCE.equals(idMethod))
96 {
97 return new SequenceIdGenerator(dbAdapter);
98 }
99 else
100 {
101 return null;
102 }
103 }
104 }