Open Source Repository

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


org/hibernate/engine/ExecuteUpdateResultCheckStyle.java
package org.hibernate.engine;

import java.io.Serializable;
import java.io.ObjectStreamException;
import java.io.InvalidObjectException;

/**
 * For persistence operations (INSERT, UPDATE, DELETE) what style of determining
 * results (success/failure) is to be used.
 *
 @author Steve Ebersole
 */
public class ExecuteUpdateResultCheckStyle implements Serializable {
  /**
   * Do not perform checking.  Either user simply does not want checking, or is
   * indicating a {@link java.sql.CallableStatement} execution in which the
   * checks are being performed explicitly and failures are handled through
   * propogation of {@link java.sql.SQLException}s.
   */
  public static final ExecuteUpdateResultCheckStyle NONE = new ExecuteUpdateResultCheckStyle"none" );
  /**
   * Perform row-count checking.  Row counts are the int values returned by both
   {@link java.sql.PreparedStatement#executeUpdate()} and
   {@link java.sql.Statement#executeBatch()}.  These values are checked
   * against some expected count.
   */
  public static final ExecuteUpdateResultCheckStyle COUNT = new ExecuteUpdateResultCheckStyle"rowcount" );
  /**
   * Essentially the same as {@link #COUNT} except that the row count actually
   * comes from an output parameter registered as part of a
   {@link java.sql.CallableStatement}.  This style explicitly prohibits
   * statement batching from being used...
   */
  public static final ExecuteUpdateResultCheckStyle PARAM = new ExecuteUpdateResultCheckStyle"param" );

  private final String name;

  private ExecuteUpdateResultCheckStyle(String name) {
    this.name = name;
  }

  private Object readResolve() throws ObjectStreamException {
    Object resolved = parsename );
    if resolved == null ) {
      throw new InvalidObjectException"unknown result style [" + name + "]" );
    }
    return resolved;
  }

  public static ExecuteUpdateResultCheckStyle parse(String name) {
    if name.equalsNONE.name ) ) {
      return NONE;
    }
    else if name.equalsCOUNT.name ) ) {
      return COUNT;
    }
    else if name.equalsPARAM.name ) ) {
      return PARAM;
    }
    else {
      return null;
    }
  }

  public static ExecuteUpdateResultCheckStyle determineDefault(String customSql, boolean callable) {
    if customSql == null ) {
      return COUNT;
    }
    else {
      return callable ? PARAM : COUNT;
    }
  }
}