Module org.seasar.doma.core
Package org.seasar.doma.jdbc.criteria.context

Class UpdateSettings

java.lang.Object
org.seasar.doma.jdbc.criteria.context.Settings
org.seasar.doma.jdbc.criteria.context.UpdateSettings
public class UpdateSettings extends Settings
Represents the settings for an UPDATE criteria query.

  • Constructor Details

    • UpdateSettings

      public UpdateSettings()

  • Method Details

    • getBatchSize

      public int getBatchSize()
      Returns the batch size.
      Returns:
      the batch size. The default value is 0.

    • setBatchSize

      public void setBatchSize(int batchSize)
      Sets the batch size.

      If the value is less than 1, it is regarded as 1.

      Parameters:
      batchSize - the batch size
      See Also:

    • getAllowEmptyWhere

      public boolean getAllowEmptyWhere()
      Returns whether the empty WHERE clause is allowed or not.
      Returns:
      whether the empty WHERE clause is allowed or not. The default value is false.

    • setAllowEmptyWhere

      public void setAllowEmptyWhere(boolean allowEmptyWhere)
      Sets whether the empty WHERE clause is allowed or not.

      If the value is true and the WHERE clause is empty, EmptyWhereClauseException will be suppressed.

      Parameters:
      allowEmptyWhere - whether the empty WHERE clause is allowed or not

    • getIgnoreVersion

      public boolean getIgnoreVersion()
      Returns whether to ignore the version property or not.
      Returns:
      whether to ignore the version property or not. The default value is false.

    • setIgnoreVersion

      public void setIgnoreVersion(boolean ignoreVersion)
      Sets whether to ignore the version property or not.

      If the value is true, the column that mapped to the version property is excluded from the SQL UPDATE statement.

      Parameters:
      ignoreVersion - whether to ignore the version property or not

    • getSuppressOptimisticLockException

      public boolean getSuppressOptimisticLockException()
      Returns whether to suppress OptimisticLockException or not.
      Returns:
      whether to suppress OptimisticLockException or not. The default value is false.

    • setSuppressOptimisticLockException

      public void setSuppressOptimisticLockException(boolean suppressOptimisticLockException)
      Sets whether to suppress OptimisticLockException or not.
      Parameters:
      suppressOptimisticLockException - whether to suppress OptimisticLockException or not

    • getExcludeNull

      public boolean getExcludeNull()
      Returns whether to exclude null properties or not.
      Returns:
      whether to exclude null properties or not. The default value is false.

    • setExcludeNull

      public void setExcludeNull(boolean excludeNull)
      Sets whether to exclude null properties or not.

      If the value is true, the null properties are excluded from the SQL UPDATE statement.

      Parameters:
      excludeNull - whether to exclude null properties or not

    • include

      public List<PropertyMetamodel<?>> include()
      Returns the included properties.
      Returns:
      the included properties

    • include

      public void include(PropertyMetamodel<?>... propertyMetamodels)
      Sets the included properties.
      Parameters:
      propertyMetamodels - the included properties

    • exclude

      public List<PropertyMetamodel<?>> exclude()
      Returns the excluded properties.
      Returns:
      the excluded properties

    • exclude

      public void exclude(PropertyMetamodel<?>... propertyMetamodels)
      Sets the excluded properties.
      Parameters:
      propertyMetamodels - the excluded properties