1 package org.apache.torque.engine.database.model;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001-2003 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.util.Hashtable;
58 import java.util.List;
59
60 import org.apache.torque.engine.EngineException;
61
62 /***
63 * A name generation factory.
64 *
65 * @author <a href="mailto:dlr@finemaltcoding.com>Daniel Rall</a>
66 * @version $Id: NameFactory.java,v 1.5 2003/08/04 05:30:29 mpoeschl Exp $
67 */
68 public class NameFactory
69 {
70 /***
71 * The fully qualified class name of the Java name generator.
72 */
73 public static final String JAVA_GENERATOR =
74 JavaNameGenerator.class.getName();
75
76 /***
77 * The fully qualified class name of the constraint name generator.
78 */
79 public static final String CONSTRAINT_GENERATOR =
80 ConstraintNameGenerator.class.getName();
81
82 /***
83 * The single instance of this class.
84 */
85 private static NameFactory instance = new NameFactory();
86
87 /***
88 * The cache of <code>NameGenerator</code> algorithms in use for
89 * name generation, keyed by fully qualified class name.
90 */
91 private Hashtable algorithms;
92
93 /***
94 * Creates a new instance with storage for algorithm implementations.
95 */
96 protected NameFactory()
97 {
98 algorithms = new Hashtable(5);
99 }
100
101 /***
102 * Factory method which retrieves an instance of the named generator.
103 *
104 * @param name The fully qualified class name of the name
105 * generation algorithm to retrieve.
106 * @return A name generator
107 */
108 protected NameGenerator getAlgorithm(String name)
109 throws EngineException
110 {
111 synchronized (algorithms)
112 {
113 NameGenerator algorithm = (NameGenerator) algorithms.get(name);
114 if (algorithm == null)
115 {
116 try
117 {
118 algorithm =
119 (NameGenerator) Class.forName(name).newInstance();
120 }
121 catch (InstantiationException e)
122 {
123 throw new EngineException("Unable to instantiate class "
124 + name + ": Make sure it's in your run-time classpath", e);
125 }
126 catch (Exception e)
127 {
128 throw new EngineException(e);
129 }
130 algorithms.put(name, algorithm);
131 }
132 return algorithm;
133 }
134 }
135
136 /***
137 * Given a list of <code>String</code> objects, implements an
138 * algorithm which produces a name.
139 *
140 * @param algorithmName The fully qualified class name of the
141 * {@link org.apache.torque.engine.database.model.NameGenerator}
142 * implementation to use to generate names.
143 * @param inputs Inputs used to generate a name.
144 * @return The generated name.
145 * @throws EngineException an exception
146 */
147 public static String generateName(String algorithmName, List inputs)
148 throws EngineException
149 {
150 NameGenerator algorithm = instance.getAlgorithm(algorithmName);
151 return algorithm.generateName(inputs);
152 }
153 }
This page was automatically generated by Maven