Open Source Repository

Home /hibernate/hibernate-3.2.4.ga | Repository Home


org/hibernate/cfg/ImprovedNamingStrategy.java
//$Id: ImprovedNamingStrategy.java 9941 2006-05-22 18:28:53Z epbernard $
package org.hibernate.cfg;

import java.io.Serializable;

import org.hibernate.util.StringHelper;
import org.hibernate.AssertionFailure;

/**
 * An improved naming strategy that prefers embedded
 * underscores to mixed case names
 @see DefaultNamingStrategy the default strategy
 @author Gavin King
 */
public class ImprovedNamingStrategy implements NamingStrategy, Serializable {

  /**
   * A convenient singleton instance
   */
  public static final NamingStrategy INSTANCE = new ImprovedNamingStrategy();

  /**
   * Return the unqualified class name, mixed case converted to
   * underscores
   */
  public String classToTableName(String className) {
    return addUnderscoresStringHelper.unqualify(className) );
  }
  /**
   * Return the full property path with underscore seperators, mixed
   * case converted to underscores
   */
  public String propertyToColumnName(String propertyName) {
    return addUnderscoresStringHelper.unqualify(propertyName) );
  }
  /**
   * Convert mixed case to underscores
   */
  public String tableName(String tableName) {
    return addUnderscores(tableName);
  }
  /**
   * Convert mixed case to underscores
   */
  public String columnName(String columnName) {
    return addUnderscores(columnName);
  }

  protected static String addUnderscores(String name) {
    StringBuffer buf = new StringBuffername.replace('.''_') );
    for (int i=1; i<buf.length()-1; i++) {
      if (
        Character.isLowerCasebuf.charAt(i-1) ) &&
        Character.isUpperCasebuf.charAt(i) ) &&
        Character.isLowerCasebuf.charAt(i+1) )
      ) {
        buf.insert(i++, '_');
      }
    }
    return buf.toString().toLowerCase();
  }

  public String collectionTableName(
      String ownerEntity, String ownerEntityTable, String associatedEntity, String associatedEntityTable,
      String propertyName
  ) {
    return tableNameownerEntityTable + '_' + propertyToColumnName(propertyName) );
  }

  /**
   * Return the argument
   */
  public String joinKeyColumnName(String joinedColumn, String joinedTable) {
    return columnNamejoinedColumn );
  }

  /**
   * Return the property name or propertyTableName
   */
  public String foreignKeyColumnName(
      String propertyName, String propertyEntityName, String propertyTableName, String referencedColumnName
  ) {
    String header = propertyName != null ? StringHelper.unqualifypropertyName : propertyTableName;
    if (header == nullthrow new AssertionFailure("NamingStrategy not properly filled");
    return columnNameheader )//+ "_" + referencedColumnName not used for backward compatibility
  }

  /**
   * Return the column name or the unqualified property name
   */
  public String logicalColumnName(String columnName, String propertyName) {
    return StringHelper.isNotEmptycolumnName ? columnName : StringHelper.unqualifypropertyName );
  }

  /**
   * Returns either the table name if explicit or
   * if there is an associated table, the concatenation of owner entity table and associated table
   * otherwise the concatenation of owner entity table and the unqualified property name
   */
  public String logicalCollectionTableName(String tableName,
                       String ownerEntityTable, String associatedEntityTable, String propertyName
  ) {
    if tableName != null ) {
      return tableName;
    }
    else {
      //use of a stringbuffer to workaround a JDK bug
      return new StringBuffer(ownerEntityTable).append("_")
          .append(
            associatedEntityTable != null ?
            associatedEntityTable :
            StringHelper.unqualifypropertyName )
          ).toString();
    }
  }
  /**
   * Return the column name if explicit or the concatenation of the property name and the referenced column
   */
  public String logicalCollectionColumnName(String columnName, String propertyName, String referencedColumn) {
    return StringHelper.isNotEmptycolumnName ?
        columnName :
        StringHelper.unqualifypropertyName "_" + referencedColumn;
  }
}