View Javadoc
1 package org.apache.torque.engine.database.model; 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.util.List; 58 59 import org.apache.torque.engine.EngineException; 60 61 /*** 62 * The generic interface to a name generation algorithm. 63 * 64 * @author <a href="mailto:dlr@finemaltcoding.com>Daniel Rall</a> 65 * @author <a href="mailto:byron_foster@byron_foster@yahoo.com>Byron Foster</a> 66 * @version $Id: NameGenerator.java,v 1.1 2003/02/10 13:20:58 mpoeschl Exp $ 67 */ 68 public interface NameGenerator 69 { 70 /*** 71 * The character used by most implementations as the separator 72 * between name elements. 73 */ 74 char STD_SEPARATOR_CHAR = '_'; 75 76 /*** 77 * Traditional method for converting schema table and column names 78 * to java names. The <code>CONV_METHOD_XXX</code> constants 79 * define how names for columns and tables in the database schema 80 * will be converted to java source names. 81 * 82 * @see JavaNameGenerator#underscoreMethod(String) 83 */ 84 String CONV_METHOD_UNDERSCORE = "underscore"; 85 86 /*** 87 * Similar to {@link #CONV_METHOD_UNDERSCORE} except nothing is 88 * converted to lowercase. 89 * 90 * @see JavaNameGenerator#javanameMethod(String) 91 */ 92 String CONV_METHOD_JAVANAME = "javaname"; 93 94 /*** 95 * Specifies no modification when converting from a schema column 96 * or table name to a java name. 97 */ 98 String CONV_METHOD_NOCHANGE = "nochange"; 99 100 /*** 101 * Given a list of <code>String</code> objects, implements an 102 * algorithm which produces a name. 103 * 104 * @param inputs Inputs used to generate a name. 105 * @return The generated name. 106 * @throws EngineException if the name could not be generated 107 */ 108 String generateName(List inputs) throws EngineException; 109 }

This page was automatically generated by Maven