com.avaje.ebeaninternal.server.querydefn.DefaultOrmUpdate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avaje-ebeanorm Show documentation
There is a newer version: 8.1.1
package com.avaje.ebeaninternal.server.querydefn;

import java.io.Serializable;

import com.avaje.ebean.EbeanServer;
import com.avaje.ebeaninternal.api.BindParams;
import com.avaje.ebeaninternal.api.SpiUpdate;
import com.avaje.ebeaninternal.server.deploy.DeployNamedUpdate;

/**
 * Default implementation of OrmUpdate.
 */
public final class DefaultOrmUpdate implements SpiUpdate, Serializable {

  private static final long serialVersionUID = -8791423602246515438L;


  private transient final EbeanServer server;

  private final Class beanType;

  /**
   * The name of the update.
   */
  private final String name;

  /**
   * The parameters used to bind to the sql.
   */
  private final BindParams bindParams = new BindParams();

  /**
   * The sql update or delete statement.
   */
  private final String updateStatement;

  /**
   * Automatically detect the table being modified by this sql. This will
   * register this information so that eBean invalidates cached objects if
   * required.
   */
  private boolean notifyCache = true;

  private int timeout;

  private String generatedSql;

  private final String baseTable;

  private final OrmUpdateType type;

  /**
   * Create with a specific server. This means you can use the
   * UpdateSql.execute() method.
   */
  public DefaultOrmUpdate(Class beanType, EbeanServer server, String baseTable, String updateStatement) {
    this.beanType = beanType;
    this.server = server;
    this.baseTable = baseTable;
    this.name = "";
    this.updateStatement = updateStatement;
    this.type = deriveType(updateStatement);

  }

  public DefaultOrmUpdate(Class beanType, EbeanServer server, String baseTable, DeployNamedUpdate namedUpdate) {

    this.beanType = beanType;
    this.server = server;
    this.baseTable = baseTable;
    this.name = namedUpdate.getName();
    this.notifyCache = namedUpdate.isNotifyCache();

    // named updates are always converted to sql as part of the initialisation
    this.updateStatement = namedUpdate.getSqlUpdateStatement();
    this.type = deriveType(updateStatement);
  }

  public DefaultOrmUpdate setTimeout(int secs) {
    this.timeout = secs;
    return this;
  }

  public Class getBeanType() {
    return beanType;
  }

  /**
   * Return the timeout in seconds.
   */
  public int getTimeout() {
    return timeout;
  }

  private SpiUpdate.OrmUpdateType deriveType(String updateStatement) {

    updateStatement = updateStatement.trim();
    int spacepos = updateStatement.indexOf(' ');
    if (spacepos == -1) {
      return SpiUpdate.OrmUpdateType.UNKNOWN;

    } else {
      String firstWord = updateStatement.substring(0, spacepos);
      if (firstWord.equalsIgnoreCase("update")) {
        return SpiUpdate.OrmUpdateType.UPDATE;

      } else if (firstWord.equalsIgnoreCase("insert")) {
        return SpiUpdate.OrmUpdateType.INSERT;

      } else if (firstWord.equalsIgnoreCase("delete")) {
        return SpiUpdate.OrmUpdateType.DELETE;
      } else {
        return SpiUpdate.OrmUpdateType.UNKNOWN;
      }
    }
  }

  public int execute() {
    return server.execute(this);
  }

  /**
   * Set this to false if you don't want eBean to automatically deduce the
   * table modification information and process it.
   * 
   * Set this to false if you don't want any cache invalidation or text index
   * management to occur. You may do this when say you update only one column
   * and you know that it is not important for cached objects or text indexes.
   * 
   */
  public DefaultOrmUpdate setNotifyCache(boolean notifyCache) {
    this.notifyCache = notifyCache;
    return this;
  }

  /**
   * Return true if the cache should be notified so that invalidates
   * appropriate objects.
   */
  public boolean isNotifyCache() {
    return notifyCache;
  }

  public String getName() {
    return name;
  }

  public String getUpdateStatement() {
    return updateStatement;
  }

  public DefaultOrmUpdate set(int position, Object value) {
    bindParams.setParameter(position, value);
    return this;
  }

  public DefaultOrmUpdate setParameter(int position, Object value) {
    bindParams.setParameter(position, value);
    return this;
  }

  public DefaultOrmUpdate setNull(int position, int jdbcType) {
    bindParams.setNullParameter(position, jdbcType);
    return this;
  }

  public DefaultOrmUpdate setNullParameter(int position, int jdbcType) {
    bindParams.setNullParameter(position, jdbcType);
    return this;
  }

  public DefaultOrmUpdate set(String name, Object value) {
    bindParams.setParameter(name, value);
    return this;
  }

  public DefaultOrmUpdate setParameter(String name, Object param) {
    bindParams.setParameter(name, param);
    return this;
  }

  public DefaultOrmUpdate setNull(String name, int jdbcType) {
    bindParams.setNullParameter(name, jdbcType);
    return this;
  }

  public DefaultOrmUpdate setNullParameter(String name, int jdbcType) {
    bindParams.setNullParameter(name, jdbcType);
    return this;
  }

  /**
   * Return the bind parameters.
   */
  public BindParams getBindParams() {
    return bindParams;
  }

  public String getGeneratedSql() {
    return generatedSql;
  }

  public void setGeneratedSql(String generatedSql) {
    this.generatedSql = generatedSql;
  }

  public String getBaseTable() {
    return baseTable;
  }

  public OrmUpdateType getOrmUpdateType() {
    return type;
  }

}