Open Source Repository

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


org/hibernate/loader/criteria/CriteriaLoader.java
//$Id: CriteriaLoader.java 11321 2007-03-20 11:51:09Z [email protected] $
package org.hibernate.loader.criteria;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.hibernate.HibernateException;
import org.hibernate.LockMode;
import org.hibernate.QueryException;
import org.hibernate.ScrollMode;
import org.hibernate.ScrollableResults;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.QueryParameters;
import org.hibernate.engine.SessionFactoryImplementor;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.impl.CriteriaImpl;
import org.hibernate.loader.OuterJoinLoader;
import org.hibernate.persister.entity.OuterJoinLoadable;
import org.hibernate.persister.entity.Lockable;
import org.hibernate.transform.ResultTransformer;
import org.hibernate.type.Type;

/**
 * A <tt>Loader</tt> for <tt>Criteria</tt> queries. Note that criteria queries are
 * more like multi-object <tt>load()</tt>s than like HQL queries.
 *
 @author Gavin King
 */
public class CriteriaLoader extends OuterJoinLoader {

  //TODO: this class depends directly upon CriteriaImpl,
  //      in the impl package ... add a CriteriaImplementor
  //      interface

  //NOTE: unlike all other Loaders, this one is NOT
  //      multithreaded, or cacheable!!

  private final CriteriaQueryTranslator translator;
  private final Set querySpaces;
  private final Type[] resultTypes;
  //the user visible aliases, which are unknown to the superclass,
  //these are not the actual "physical" SQL aliases
  private final String[] userAliases;

  public CriteriaLoader(
      final OuterJoinLoadable persister,
      final SessionFactoryImplementor factory,
      final CriteriaImpl criteria,
      final String rootEntityName,
      final Map enabledFilters)
  throws HibernateException {
    super(factory, enabledFilters);

    translator = new CriteriaQueryTranslator(
        factory,
        criteria,
        rootEntityName,
        CriteriaQueryTranslator.ROOT_SQL_ALIAS
      );

    querySpaces = translator.getQuerySpaces();

    CriteriaJoinWalker walker = new CriteriaJoinWalker(
        persister,
        translator,
        factory,
        criteria,
        rootEntityName,
        enabledFilters
      );

    initFromWalker(walker);

    userAliases = walker.getUserAliases();
    resultTypes = walker.getResultTypes();

    postInstantiate();

  }

  public ScrollableResults scroll(SessionImplementor session, ScrollMode scrollMode)
  throws HibernateException {
    QueryParameters qp = translator.getQueryParameters();
    qp.setScrollMode(scrollMode);
    return scroll(qp, resultTypes, null, session);
  }

  public List list(SessionImplementor session)
  throws HibernateException {
    return listsession, translator.getQueryParameters(), querySpaces, resultTypes );

  }

  protected Object getResultColumnOrRow(Object[] row, ResultTransformer transformer, ResultSet rs, SessionImplementor session)
  throws SQLException, HibernateException {
    final Object[] result;
    final String[] aliases;
    if translator.hasProjection() ) {
      Type[] types = translator.getProjectedTypes();
      result = new Object[types.length];
      String[] columnAliases = translator.getProjectedColumnAliases();
      for int i=0; i<result.length; i++ ) {
        result[i= types[i].nullSafeGet(rs, columnAliases[i], session, null);
      }
      aliases = translator.getProjectedAliases();
    }
    else {
      result = row;
      aliases = userAliases;
    }
    return translator.getRootCriteria().getResultTransformer()
        .transformTuple(result, aliases);
  }

  public Set getQuerySpaces() {
    return querySpaces;
  }

  protected String applyLocks(String sqlSelectString, Map lockModes, Dialect dialectthrows QueryException {
    if lockModes == null || lockModes.isEmpty() ) {
      return sqlSelectString;
    }

    final Map aliasedLockModes = new HashMap();
    final Map keyColumnNames = dialect.forUpdateOfColumns() new HashMap() null;
    final String[] drivingSqlAliases = getAliases();
    for int i = 0; i < drivingSqlAliases.length; i++ ) {
      final LockMode lockMode = LockMode lockModes.getdrivingSqlAliases[i] );
      if lockMode != null ) {
        final Lockable drivingPersister = Lockable getEntityPersisters()[i];
        final String rootSqlAlias = drivingPersister.getRootTableAliasdrivingSqlAliases[i] );
        aliasedLockModes.putrootSqlAlias, lockMode );
        if keyColumnNames != null ) {
          keyColumnNames.putrootSqlAlias, drivingPersister.getRootTableIdentifierColumnNames() );
        }
      }
    }
    return dialect.applyLocksToSqlsqlSelectString, aliasedLockModes, keyColumnNames );
  }

  protected LockMode[] getLockModes(Map lockModes) {
    final String[] entityAliases = getAliases();
    if entityAliases == null ) {
      return null;
    }
    final int size = entityAliases.length;
    LockMode[] lockModesArray = new LockMode[size];
    for int i=0; i<size; i++ ) {
      LockMode lockMode = (LockModelockModes.getentityAliases[i] );
      lockModesArray[i= lockMode==null ? LockMode.NONE : lockMode;
    }
    return lockModesArray;
  }

  protected boolean isSubselectLoadingEnabled() {
    return hasSubselectLoadableCollections();
  }

  protected List getResultList(List results, ResultTransformer resultTransformer) {
    return translator.getRootCriteria().getResultTransformer().transformListresults );
  }

}