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.List;
58
59 import org.apache.commons.logging.Log;
60 import org.apache.commons.logging.LogFactory;
61
62 import org.apache.torque.engine.EngineException;
63
64 /***
65 * A <code>NameGenerator</code> implementation for table-specific
66 * constraints. Conforms to the maximum column name length for the
67 * type of database in use.
68 *
69 * @author <a href="mailto:dlr@finemaltcoding.com>Daniel Rall</a>
70 * @version $Id: ConstraintNameGenerator.java,v 1.2 2003/06/26 06:59:56 mpoeschl Exp $
71 */
72 public class ConstraintNameGenerator implements NameGenerator
73 {
74 /*** Logging class from commons.logging */
75 private static Log log = LogFactory.getLog(ConstraintNameGenerator.class);
76
77 /***
78 * First element of <code>inputs</code> should be of type {@link
79 * org.apache.torque.engine.database.model.Database}, second
80 * should be a table name, third is the type identifier (spared if
81 * trimming is necessary due to database type length constraints),
82 * and the fourth is a <code>Integer</code> indicating the number
83 * of this contraint.
84 *
85 * @see org.apache.torque.engine.database.model.NameGenerator
86 */
87 public String generateName(List inputs)
88 throws EngineException
89 {
90 StringBuffer name = new StringBuffer();
91 Database db = (Database) inputs.get(0);
92 name.append((String) inputs.get(1));
93 String namePostfix = (String) inputs.get(2);
94 String constraintNbr = inputs.get(3).toString();
95
96 // Calculate maximum RDBMS-specific column character limit.
97 int maxBodyLength = -1;
98 try
99 {
100 int maxColumnNameLength =
101 Integer.parseInt(db.getProperty("maxColumnNameLength"));
102 maxBodyLength = (maxColumnNameLength - namePostfix.length()
103 - constraintNbr.length() - 2);
104
105 if (log.isDebugEnabled())
106 {
107 log.debug("maxColumnNameLength=" + maxColumnNameLength
108 + " maxBodyLength=" + maxBodyLength);
109 }
110 }
111 catch (EngineException e)
112 {
113 log.error(e.getMessage(), e);
114 }
115 catch (NumberFormatException maxLengthUnknown)
116 {
117 }
118
119 // Do any necessary trimming.
120 if (maxBodyLength != -1 && name.length() > maxBodyLength)
121 {
122 name.setLength(maxBodyLength);
123 }
124
125 name.append(STD_SEPARATOR_CHAR).append(namePostfix)
126 .append(STD_SEPARATOR_CHAR).append(constraintNbr);
127
128 return name.toString();
129 }
130 }
This page was automatically generated by Maven