Open Source Repository

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


org/hibernate/persister/entity/UnionSubclassEntityPersister.java
//$Id: UnionSubclassEntityPersister.java 10040 2006-06-22 19:51:43Z [email protected] $
package org.hibernate.persister.entity;

import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.ArrayList;

import org.hibernate.AssertionFailure;
import org.hibernate.Hibernate;
import org.hibernate.HibernateException;
import org.hibernate.LockMode;
import org.hibernate.MappingException;
import org.hibernate.cache.CacheConcurrencyStrategy;
import org.hibernate.cfg.Settings;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.Mapping;
import org.hibernate.engine.SessionFactoryImplementor;
import org.hibernate.engine.ExecuteUpdateResultCheckStyle;
import org.hibernate.id.IdentityGenerator;
import org.hibernate.mapping.Column;
import org.hibernate.mapping.PersistentClass;
import org.hibernate.mapping.Subclass;
import org.hibernate.mapping.Table;
import org.hibernate.sql.SelectFragment;
import org.hibernate.sql.SimpleSelect;
import org.hibernate.type.Type;
import org.hibernate.util.ArrayHelper;
import org.hibernate.util.JoinedIterator;
import org.hibernate.util.SingletonIterator;

/**
 * Implementation of the "table-per-concrete-class" or "roll-down" mapping 
 * strategy for an entity and its inheritence hierarchy.
 *
 @author Gavin King
 */
public class UnionSubclassEntityPersister extends AbstractEntityPersister {

  // the class hierarchy structure
  private final String subquery;
  private final String tableName;
  //private final String rootTableName;
  private final String[] subclassClosure;
  private final String[] spaces;
  private final String[] subclassSpaces;
  private final String discriminatorSQLValue;
  private final Map subclassByDiscriminatorValue = new HashMap();

  private final String[] constraintOrderedTableNames;
  private final String[][] constraintOrderedKeyColumnNames;

  //INITIALIZATION:

  public UnionSubclassEntityPersister(
      final PersistentClass persistentClass, 
      final CacheConcurrencyStrategy cache, 
      final SessionFactoryImplementor factory,
      final Mapping mapping)
  throws HibernateException {

    super(persistentClass, cache, factory);
    
    if getIdentifierGenerator() instanceof IdentityGenerator ) {
      throw new MappingException(
          "Cannot use identity column key generation with <union-subclass> mapping for: " 
          getEntityName() 
      );
    }

    // TABLE

    tableName = persistentClass.getTable().getQualifiedName
        factory.getDialect()
        factory.getSettings().getDefaultCatalogName()
        factory.getSettings().getDefaultSchemaName() 
    );
    /*rootTableName = persistentClass.getRootTable().getQualifiedName( 
        factory.getDialect(), 
        factory.getDefaultCatalog(), 
        factory.getDefaultSchema() 
    );*/

    //Custom SQL

    String sql;
    boolean callable = false;
    ExecuteUpdateResultCheckStyle checkStyle = null;
    sql = persistentClass.getCustomSQLInsert();
    callable = sql != null && persistentClass.isCustomInsertCallable();
    checkStyle = sql == null
        ? ExecuteUpdateResultCheckStyle.COUNT
              : persistentClass.getCustomSQLInsertCheckStyle() == null
            ? ExecuteUpdateResultCheckStyle.determineDefaultsql, callable )
                      : persistentClass.getCustomSQLInsertCheckStyle();
    customSQLInsert = new String[] { sql };
    insertCallable = new boolean[] { callable };
    insertResultCheckStyles = new ExecuteUpdateResultCheckStyle[] { checkStyle };

    sql = persistentClass.getCustomSQLUpdate();
    callable = sql != null && persistentClass.isCustomUpdateCallable();
    checkStyle = sql == null
        ? ExecuteUpdateResultCheckStyle.COUNT
              : persistentClass.getCustomSQLUpdateCheckStyle() == null
            ? ExecuteUpdateResultCheckStyle.determineDefaultsql, callable )
                      : persistentClass.getCustomSQLUpdateCheckStyle();
    customSQLUpdate = new String[] { sql };
    updateCallable = new boolean[] { callable };
    updateResultCheckStyles = new ExecuteUpdateResultCheckStyle[] { checkStyle };

    sql = persistentClass.getCustomSQLDelete();
    callable = sql != null && persistentClass.isCustomDeleteCallable();
    checkStyle = sql == null
        ? ExecuteUpdateResultCheckStyle.COUNT
              : persistentClass.getCustomSQLDeleteCheckStyle() == null
            ? ExecuteUpdateResultCheckStyle.determineDefaultsql, callable )
                      : persistentClass.getCustomSQLDeleteCheckStyle();
    customSQLDelete = new String[] { sql };
    deleteCallable = new boolean[] { callable };
    deleteResultCheckStyles = new ExecuteUpdateResultCheckStyle[] { checkStyle };

    discriminatorSQLValue = String.valueOfpersistentClass.getSubclassId() );

    // PROPERTIES

    int subclassSpan = persistentClass.getSubclassSpan() 1;
    subclassClosure = new String[subclassSpan];
    subclassClosure[0= getEntityName();

    // SUBCLASSES
    subclassByDiscriminatorValue.put
        new IntegerpersistentClass.getSubclassId() )
        persistentClass.getEntityName() 
    );
    if persistentClass.isPolymorphic() ) {
      Iterator iter = persistentClass.getSubclassIterator();
      int k=1;
      while iter.hasNext() ) {
        Subclass sc = (Subclassiter.next();
        subclassClosure[k++= sc.getEntityName();
        subclassByDiscriminatorValue.putnew Integersc.getSubclassId() ), sc.getEntityName() );
      }
    }
    
    //SPACES
    //TODO: i'm not sure, but perhaps we should exclude
    //      abstract denormalized tables?
    
    int spacesSize = + persistentClass.getSynchronizedTables().size();
    spaces = new String[spacesSize];
    spaces[0= tableName;
    Iterator iter = persistentClass.getSynchronizedTables().iterator();
    for int i=1; i<spacesSize; i++ ) {
      spaces[i(Stringiter.next();
    }
    
    HashSet subclassTables = new HashSet();
    iter = persistentClass.getSubclassTableClosureIterator();
    while iter.hasNext() ) {
      Table table = (Tableiter.next();
      subclassTables.addtable.getQualifiedName(
          factory.getDialect()
          factory.getSettings().getDefaultCatalogName()
          factory.getSettings().getDefaultSchemaName() 
      ) );
    }
    subclassSpaces = ArrayHelper.toStringArray(subclassTables);

    subquery = generateSubquery(persistentClass, mapping);

    if isMultiTable() ) {
      int idColumnSpan = getIdentifierColumnSpan();
      ArrayList tableNames = new ArrayList();
      ArrayList keyColumns = new ArrayList();
      if !isAbstract() ) {
        tableNames.addtableName );
        keyColumns.addgetIdentifierColumnNames() );
      }
      iter = persistentClass.getSubclassTableClosureIterator();
      while iter.hasNext() ) {
        Table tab = Table iter.next();
        if !tab.isAbstractUnionTable() ) {
          String tableName = tab.getQualifiedName(
              factory.getDialect(),
              factory.getSettings().getDefaultCatalogName(),
              factory.getSettings().getDefaultSchemaName()
          );
          tableNames.addtableName );
          String[] key = new String[idColumnSpan];
          Iterator citer = tab.getPrimaryKey().getColumnIterator();
          for int k=0; k<idColumnSpan; k++ ) {
            key[k( ( Column citer.next() ).getQuotedNamefactory.getDialect() );
          }
          keyColumns.addkey );
        }
      }

      constraintOrderedTableNames = ArrayHelper.toStringArraytableNames );
      constraintOrderedKeyColumnNames = ArrayHelper.to2DStringArraykeyColumns );
    }
    else {
      constraintOrderedTableNames = new String[] { tableName };
      constraintOrderedKeyColumnNames = new String[][] { getIdentifierColumnNames() };
    }

    initLockers();

    initSubclassPropertyAliasesMap(persistentClass);
    
    postConstruct(mapping);

  }

  public Serializable[] getQuerySpaces() {
    return subclassSpaces;
  }
  
  public String getTableName() {
    return subquery;
  }

  public Type getDiscriminatorType() {
    return Hibernate.INTEGER;
  }

  public String getDiscriminatorSQLValue() {
    return discriminatorSQLValue;
  }

  public String[] getSubclassClosure() {
    return subclassClosure;
  }

  public String getSubclassForDiscriminatorValue(Object value) {
    return (StringsubclassByDiscriminatorValue.get(value);
  }

  public Serializable[] getPropertySpaces() {
    return spaces;
  }

  protected boolean isDiscriminatorFormula() {
    return false;
  }

  /**
   * Generate the SQL that selects a row by id
   */
  protected String generateSelectString(LockMode lockMode) {
    SimpleSelect select = new SimpleSelectgetFactory().getDialect() )
      .setLockMode(lockMode)
      .setTableNamegetTableName() )
      .addColumnsgetIdentifierColumnNames() )
      .addColumns
          getSubclassColumnClosure()
          getSubclassColumnAliasClosure(),
          getSubclassColumnLazyiness()
      )
      .addColumns
          getSubclassFormulaClosure()
          getSubclassFormulaAliasClosure(),
          getSubclassFormulaLazyiness()
      );
    //TODO: include the rowids!!!!
    if hasSubclasses() ) {
      if isDiscriminatorFormula() ) {
        select.addColumngetDiscriminatorFormula(), getDiscriminatorAlias() );
      }
      else {
        select.addColumngetDiscriminatorColumnName(), getDiscriminatorAlias() );
      }
    }
    if getFactory().getSettings().isCommentsEnabled() ) {
      select.setComment"load " + getEntityName() );
    }
    return select.addConditiongetIdentifierColumnNames()"=?" ).toStatementString();
  }

  protected String getDiscriminatorFormula() {
    return null;
  }

  protected String getTableName(int j) {
    return tableName;
  }

  protected String[] getKeyColumns(int j) {
    return getIdentifierColumnNames();
  }
  
  protected boolean isTableCascadeDeleteEnabled(int j) {
    return false;
  }
  
  protected boolean isPropertyOfTable(int property, int j) {
    return true;
  }

  // Execute the SQL:

  public String fromTableFragment(String name) {
    return getTableName() ' '  + name;
  }

  public String filterFragment(String name) {
    return hasWhere() ?
      " and " + getSQLWhereString(name:
      "";
  }

  public String getSubclassPropertyTableName(int i) {
    return getTableName();//ie. the subquery! yuck!
  }

  protected void addDiscriminatorToSelect(SelectFragment select, String name, String suffix) {
    select.addColumnname, getDiscriminatorColumnName(),  getDiscriminatorAlias() );
  }
  
  protected int[] getPropertyTableNumbersInSelect() {
    return new intgetPropertySpan() ];
  }

  protected int getSubclassPropertyTableNumber(int i) {
    return 0;
  }

  public int getSubclassPropertyTableNumber(String propertyName) {
    return 0;
  }

  public boolean isMultiTable() {
    // This could also just be true all the time...
    return isAbstract() || hasSubclasses();
  }

  public int getTableSpan() {
    return 1;
  }

  protected int[] getSubclassColumnTableNumberClosure() {
    return new intgetSubclassColumnClosure().length ];
  }

  protected int[] getSubclassFormulaTableNumberClosure() {
    return new intgetSubclassFormulaClosure().length ];
  }

  protected boolean[] getTableHasColumns() {
    return new boolean[] { true };
  }

  protected int[] getPropertyTableNumbers() {
    return new intgetPropertySpan() ];
  }

  protected String generateSubquery(PersistentClass model, Mapping mapping) {

    Dialect dialect = getFactory().getDialect();
    Settings settings = getFactory().getSettings();
    
    if !model.hasSubclasses() ) {
      return model.getTable().getQualifiedName(
          dialect,
          settings.getDefaultCatalogName(),
          settings.getDefaultSchemaName()
        );
    }

    HashSet columns = new HashSet();
    Iterator titer = model.getSubclassTableClosureIterator();
    while titer.hasNext() ) {
      Table table = (Tabletiter.next();
      if !table.isAbstractUnionTable() ) {
        Iterator citer = table.getColumnIterator();
        while citer.hasNext() ) columns.addciter.next() );
      }
    }

    StringBuffer buf = new StringBuffer()
      .append("( ");

    Iterator siter = new JoinedIterator(
      new SingletonIterator(model),
      model.getSubclassIterator()
    );

    while siter.hasNext() ) {
      PersistentClass clazz = (PersistentClasssiter.next();
      Table table = clazz.getTable();
      if !table.isAbstractUnionTable() ) {
        //TODO: move to .sql package!!
        buf.append("select ");
        Iterator citer = columns.iterator();
        while citer.hasNext() ) {
          Column col = (Columnciter.next();
          if !table.containsColumn(col) ) {
            int sqlType = col.getSqlTypeCode(mapping);
            buf.appenddialect.getSelectClauseNullString(sqlType) )
              .append(" as ");
          }
          buf.appendcol.getName() );
          buf.append(", ");
        }
        buf.appendclazz.getSubclassId() )
          .append(" as clazz_");
        buf.append(" from ")
          .appendtable.getQualifiedName(
              dialect,
              settings.getDefaultCatalogName(),
              settings.getDefaultSchemaName()
          ) );
        buf.append(" union ");
        if dialect.supportsUnionAll() ) {
          buf.append("all ");
        }
      }
    }
    
    if buf.length() ) {
      //chop the last union (all)
      buf.setLengthbuf.length() dialect.supportsUnionAll() 11 ) );
    }

    return buf.append(" )").toString();
  }

  protected String[] getSubclassTableKeyColumns(int j) {
    if (j!=0throw new AssertionFailure("only one table");
    return getIdentifierColumnNames();
  }

  public String getSubclassTableName(int j) {
    if (j!=0throw new AssertionFailure("only one table");
    return tableName;
  }

  public int getSubclassTableSpan() {
    return 1;
  }

  protected boolean isClassOrSuperclassTable(int j) {
    if (j!=0throw new AssertionFailure("only one table");
    return true;
  }

  public String getPropertyTableName(String propertyName) {
    //TODO: check this....
    return getTableName();
  }

  public String[] getConstraintOrderedTableNameClosure() {
      return constraintOrderedTableNames;
  }

  public String[][] getContraintOrderedTableKeyColumnClosure() {
    return constraintOrderedKeyColumnNames;
  }
}