Open Source Repository

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


org/hibernate/criterion/Order.java
//$Id: Order.java 7495 2005-07-15 16:52:10Z oneovthafew $
package org.hibernate.criterion;

import java.io.Serializable;
import java.sql.Types;

import org.hibernate.Criteria;
import org.hibernate.HibernateException;
import org.hibernate.engine.SessionFactoryImplementor;
import org.hibernate.type.Type;

/**
 * Represents an order imposed upon a <tt>Criteria</tt> result set
 @author Gavin King
 */
public class Order implements Serializable {

  private boolean ascending;
  private boolean ignoreCase;
  private String propertyName;
  
  public String toString() {
    return propertyName + ' ' (ascending?"asc":"desc");
  }
  
  public Order ignoreCase() {
    ignoreCase = true;
    return this;
  }

  /**
   * Constructor for Order.
   */
  protected Order(String propertyName, boolean ascending) {
    this.propertyName = propertyName;
    this.ascending = ascending;
  }

  /**
   * Render the SQL fragment
   *
   */
  public String toSqlString(Criteria criteria, CriteriaQuery criteriaQuery
  throws HibernateException {
    String[] columns = criteriaQuery.getColumnsUsingProjection(criteria, propertyName);
    Type type = criteriaQuery.getTypeUsingProjection(criteria, propertyName);
    StringBuffer fragment = new StringBuffer();
    for int i=0; i<columns.length; i++ ) {
      SessionFactoryImplementor factory = criteriaQuery.getFactory();
      boolean lower = ignoreCase && type.sqlTypesfactory )[i]==Types.VARCHAR;
      if (lower) {
        fragment.appendfactory.getDialect().getLowercaseFunction() )
          .append('(');
      }
      fragment.appendcolumns[i] );
      if (lowerfragment.append(')');
      fragment.appendascending ? " asc" " desc" );
      if i<columns.length-fragment.append(", ");
    }
    return fragment.toString();
  }

  /**
   * Ascending order
   *
   @param propertyName
   @return Order
   */
  public static Order asc(String propertyName) {
    return new Order(propertyName, true);
  }

  /**
   * Descending order
   *
   @param propertyName
   @return Order
   */
  public static Order desc(String propertyName) {
    return new Order(propertyName, false);
  }

}