org.dbflute.bhv.writable.UpdateOption Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
/*
* Copyright 2014-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.dbflute.bhv.writable;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.dbflute.Entity;
import org.dbflute.cbean.ConditionBean;
import org.dbflute.cbean.chelper.HpCalcSpecification;
import org.dbflute.cbean.coption.StatementConfigCall;
import org.dbflute.cbean.dream.ColumnCalculator;
import org.dbflute.cbean.dream.SpecifiedColumn;
import org.dbflute.cbean.scoping.SpecifyQuery;
import org.dbflute.cbean.sqlclause.SqlClause;
import org.dbflute.dbmeta.DBMeta;
import org.dbflute.dbmeta.info.ColumnInfo;
import org.dbflute.dbmeta.info.PrimaryInfo;
import org.dbflute.dbmeta.info.UniqueInfo;
import org.dbflute.exception.BatchUpdateColumnModifiedPropertiesFragmentedException;
import org.dbflute.exception.IllegalConditionBeanOperationException;
import org.dbflute.exception.SpecifyUpdateColumnInvalidException;
import org.dbflute.exception.VaryingUpdateCalculationUnsupportedColumnTypeException;
import org.dbflute.exception.VaryingUpdateCommonColumnSpecificationException;
import org.dbflute.exception.VaryingUpdateInvalidColumnSpecificationException;
import org.dbflute.exception.VaryingUpdateNotFoundCalculationException;
import org.dbflute.exception.VaryingUpdateOptimisticLockSpecificationException;
import org.dbflute.exception.VaryingUpdatePrimaryKeySpecificationException;
import org.dbflute.helper.StringKeyMap;
import org.dbflute.helper.message.ExceptionMessageBuilder;
import org.dbflute.jdbc.StatementConfig;
import org.dbflute.util.DfCollectionUtil;
import org.dbflute.util.DfTypeUtil;
/**
* The option of update for varying-update.
* @param The type of condition-bean for specification.
* @author jflute
* @since 0.9.7.2 (2010/06/18 Friday)
*/
public class UpdateOption implements WritableOption {
// ===================================================================================
// Attribute
// =========
// SelfCalculation specification
protected List> _selfSpecificationList;
protected Map> _selfSpecificationMap;
// UpdateColumn specification
protected SpecifyQuery _updateColumnSpecification;
protected CB _updateColumnSpecifiedCB;
protected Set _forcedSpecifiedUpdateColumnSet;
// UniqueBy
protected UniqueInfo _uniqueByUniqueInfo;
// small option for UpdateColumn adjustment
protected boolean _exceptCommonColumnForcedSpecified;
protected boolean _updateColumnModifiedPropertiesFragmentedAllowed; // as default of batch update
protected boolean _compatibleBatchUpdateDefaultEveryColumn;
protected boolean _disableCommonColumnAutoSetup;
// small option for QueryUpdate condition
protected boolean _nonQueryUpdateAllowed;
protected boolean _queryUpdateForcedDirectAllowed;
// small option for BatchUpdate logging
protected Integer _batchLoggingUpdateLimit;
// small option for InsertOrUpdate count pre-check
protected boolean _insertOrUpdateCountPreChecked;
// small option for UniqueBy PK handling
protected boolean _reloadPrimaryKeyIfUniqueBy;
// configuration for JDBC statement e.g. queryTimeout
protected StatementConfig _updateStatementConfig;
// ===================================================================================
// Constructor
// ===========
/**
* Constructor.
*
* Purchase purchase = new Purchase();
* purchase.setPurchaseId(value); // required
* purchase.setOther...(value); // you should set only modified columns
*
* // e.g. you can update by self calculation values
* purchaseBhv.varyingUpdate(purchase, op -> {
* op.self(cb -> {
* cb.specify().columnPurchaseCount();
* }).plus(1); // PURCHASE_COUNT = PURCHASE_COUNT + 1
*
* // e.g. you can update by your values for common columns
* op.disableCommonColumnAutoSetup();
* });
*
*/
public UpdateOption() {
}
// ===================================================================================
// Self Calculation
// ================
/**
* Specify a self calculation as update value.
* You can specify a column except PK column, common column and optimistic-lock column.
* And you can specify only one column that is a number type.
*
* Purchase purchase = new Purchase();
* purchase.setPurchaseId(value); // required
* purchase.setOther...(value); // you should set only modified columns
* purchaseBhv.varyingUpdateNonstrict(purchase, op -> {
* op.self(cb -> {
* cb.specify().columnPurchaseCount();
* }).plus(1); // PURCHASE_COUNT = PURCHASE_COUNT + 1
* });
*
* @param colCBLambda The callback for query for specification that specifies only one column. (NotNull)
* @return The calculation of specification for the specified column. (NotNull)
*/
public ColumnCalculator self(SpecifyQuery colCBLambda) {
if (colCBLambda == null) {
String msg = "The argument 'colCBLambda' should not be null.";
throw new IllegalArgumentException(msg);
}
if (_selfSpecificationList == null) {
_selfSpecificationList = DfCollectionUtil.newArrayList();
}
final HpCalcSpecification specification = createCalcSpecification(colCBLambda);
_selfSpecificationList.add(specification);
return specification;
}
protected HpCalcSpecification createCalcSpecification(SpecifyQuery colCBLambda) {
return newCalcSpecification(colCBLambda);
}
protected HpCalcSpecification newCalcSpecification(SpecifyQuery colCBLambda) {
return new HpCalcSpecification(colCBLambda);
}
public boolean hasSelfSpecification() {
return _selfSpecificationList != null && !_selfSpecificationList.isEmpty();
}
public static interface UpdateSelfSpecificationCBFactory {
CB create();
}
public void resolveSelfSpecification(UpdateSelfSpecificationCBFactory factory) {
if (_selfSpecificationList == null || _selfSpecificationList.isEmpty()) {
return;
}
_selfSpecificationMap = StringKeyMap.createAsFlexibleOrdered();
for (HpCalcSpecification specification : _selfSpecificationList) {
final CB cb = factory.create(); // needs independent instance per specification
specification.specify(cb);
final String columnDbName = specification.getResolvedSpecifiedColumnDbName();
assertSpecifiedColumn(cb, columnDbName);
_selfSpecificationMap.put(columnDbName, specification);
}
}
protected void assertSpecifiedColumn(CB cb, String columnDbName) {
if (columnDbName == null) {
throwVaryingUpdateInvalidColumnSpecificationException(cb);
}
final ColumnInfo columnInfo = cb.asDBMeta().findColumnInfo(columnDbName);
if (columnInfo.isPrimary()) {
throwVaryingUpdatePrimaryKeySpecificationException(columnInfo);
}
if (columnInfo.isCommonColumn()) {
throwVaryingUpdateCommonColumnSpecificationException(columnInfo);
}
if (columnInfo.isOptimisticLock()) {
throwVaryingUpdateOptimisticLockSpecificationException(columnInfo);
}
if (!columnInfo.isObjectNativeTypeNumber() && !columnInfo.isObjectNativeTypeDate()) {
// *simple message because other types may be supported at the future
String msg = "Not number or date column specified: " + columnInfo;
throw new VaryingUpdateCalculationUnsupportedColumnTypeException(msg);
}
}
protected void throwVaryingUpdateInvalidColumnSpecificationException(CB cb) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The specified column for varying-update was invalid.");
br.addItem("Advice");
br.addElement("You should call specify().column[TargetColumn]() only once.");
br.addElement("For example:");
br.addElement("");
br.addElement(" (x):");
br.addElement(" option.self(cb -> {");
br.addElement(" // *no, empty");
br.addElement(" });");
br.addElement(" (x):");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount();");
br.addElement(" cb.specify().columnPurchasePrice(); // *no, duplicated");
br.addElement(" });");
br.addElement(" (o)");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount(); // OK");
br.addElement(" });");
br.addItem("Target Table");
br.addElement(cb.asTableDbName());
final String msg = br.buildExceptionMessage();
throw new VaryingUpdateInvalidColumnSpecificationException(msg);
}
protected void throwVaryingUpdatePrimaryKeySpecificationException(ColumnInfo columnInfo) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The primary key column was specified.");
br.addItem("Advice");
br.addElement("Varying-update is not allowed to specify a PK column.");
br.addItem("Target Table");
br.addElement(columnInfo.getDBMeta().getTableDbName());
br.addItem("Specified Column");
br.addElement(columnInfo);
final String msg = br.buildExceptionMessage();
throw new VaryingUpdatePrimaryKeySpecificationException(msg);
}
protected void throwVaryingUpdateCommonColumnSpecificationException(ColumnInfo columnInfo) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The column for optimistic lock was specified.");
br.addItem("Advice");
br.addElement("Varying-update is not allowed to specify a optimistic-lock column.");
br.addItem("Target Table");
br.addElement(columnInfo.getDBMeta().getTableDbName());
br.addItem("Specified Column");
br.addElement(columnInfo);
final String msg = br.buildExceptionMessage();
throw new VaryingUpdateCommonColumnSpecificationException(msg);
}
protected void throwVaryingUpdateOptimisticLockSpecificationException(ColumnInfo columnInfo) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The column for optimistic lock was specified.");
br.addItem("Advice");
br.addElement("Varying-update is not allowed to specify a optimistic-lock column.");
br.addItem("Target Table");
br.addElement(columnInfo.getDBMeta().getTableDbName());
br.addItem("Specified Column");
br.addElement(columnInfo);
final String msg = br.buildExceptionMessage();
throw new VaryingUpdateOptimisticLockSpecificationException(msg);
}
protected String getSpecifiedColumnDbNameAsOne(CB cb) {
return cb.getSqlClause().getSpecifiedColumnDbNameAsOne();
}
// ===================================================================================
// Build Statement
// ===============
public boolean hasStatement(String columnDbName) {
return findStatementSpecification(columnDbName) != null;
}
public String buildStatement(String columnDbName) {
return doBuildStatement(columnDbName, null);
}
public String buildStatement(String columnDbName, String aliasName) {
return doBuildStatement(columnDbName, aliasName);
}
protected String doBuildStatement(String columnDbName, String aliasName) {
final HpCalcSpecification calcSp = findStatementSpecification(columnDbName);
if (calcSp == null) {
return null;
}
final SpecifiedColumn specifiedColumn = calcSp.getResolvedSpecifiedColumn();
if (specifiedColumn != null && specifiedColumn.hasSpecifyCalculation()) {
throwVaryingUpdateSpecifyCalculatonUnsupportedException(columnDbName);
}
final String statement = calcSp.buildStatementAsSqlName(aliasName);
if (statement == null) { // means non-calculation
throwVaryingUpdateNotFoundCalculationException(columnDbName);
}
return statement;
}
protected HpCalcSpecification findStatementSpecification(String columnDbName) {
// only "self" supported yet
return _selfSpecificationMap != null ? _selfSpecificationMap.get(columnDbName) : null;
}
protected void throwVaryingUpdateSpecifyCalculatonUnsupportedException(String columnDbName) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("VaryingUpdate with SpecifyCalculation is unsupported.");
br.addItem("Advice");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount().plus(1); // *NG");
br.addElement(" }).multiply(3);");
br.addElement(" (o):");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount();");
br.addElement(" }).plus(1).multiply(3); // OK");
br.addItem("Specified Column");
br.addElement(columnDbName);
final String msg = br.buildExceptionMessage();
throw new IllegalConditionBeanOperationException(msg); // because of specified by ConditionBean
}
protected void throwVaryingUpdateNotFoundCalculationException(String columnDbName) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The calculation of specified column for VaryingUpdate was not found.");
br.addItem("Advice");
br.addElement("You should call plus()/minus()/... methods after specification.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount();");
br.addElement(" }); // *NG");
br.addElement(" (o):");
br.addElement(" option.self(cb -> {");
br.addElement(" cb.specify().columnPurchaseCount();");
br.addElement(" }).plus(1); // OK");
br.addItem("Specified Column");
br.addElement(columnDbName);
final String msg = br.buildExceptionMessage();
throw new VaryingUpdateNotFoundCalculationException(msg);
}
// ===================================================================================
// Update Column
// =============
// -----------------------------------------------------
// Specify Column
// --------------
/**
* Specify update columns manually.
* You can update fixed columns instead of modified update columns.
*
* Member member = new Member();
* member.setMemberId(3);
* member.setOthers...(value);
* memberBhv.varyingUpdate(member, op -> {
* op.specify(cb -> {
* // only MemberName and Birthdate are updated
* // with common columns for update and an exclusive control column
* cb.specify().columnMemberName();
* cb.specify().columnBirthdate();
* });
* });
*
* @param colCBLambda The callback for query of specifying update columns. (NotNull)
*/
public void specify(SpecifyQuery colCBLambda) {
if (colCBLambda == null) {
String msg = "The argument 'updateColumnSpecification' should not be null.";
throw new IllegalArgumentException(msg);
}
_updateColumnSpecification = colCBLambda;
}
public void resolveUpdateColumnSpecification(CB cb) {
if (_updateColumnSpecification == null) {
return;
}
_updateColumnSpecification.specify(cb);
_updateColumnSpecifiedCB = cb;
if (!_exceptCommonColumnForcedSpecified) {
xacceptCommonColumnForcedSpecification(cb);
}
// an exclusive control column is specified forcedly by behavior's logic
}
// -----------------------------------------------------
// Common Column
// -------------
/**
* Except common columns from forced specified update columns.
* @return The option of update. (NotNull: returns this)
*/
public UpdateOption exceptCommonColumnForcedSpecified() {
_exceptCommonColumnForcedSpecified = true;
return this;
}
protected void xacceptCommonColumnForcedSpecification(CB cb) { // internal
final List beforeUpdateList = cb.asDBMeta().getCommonColumnInfoBeforeUpdateList();
if (beforeUpdateList == null || beforeUpdateList.isEmpty()) {
return;
}
for (ColumnInfo columnInfo : beforeUpdateList) {
addForcedSpecifiedUpdateColumn(columnInfo);
}
}
protected void addForcedSpecifiedUpdateColumn(ColumnInfo columnInfo) {
if (_forcedSpecifiedUpdateColumnSet == null) {
_forcedSpecifiedUpdateColumnSet = DfCollectionUtil.newHashSet();
}
_forcedSpecifiedUpdateColumnSet.add(columnInfo.getColumnDbName());
}
// -----------------------------------------------------
// Modified Properties
// -------------------
// for BatchUpdate
public void xacceptUpdateColumnModifiedPropertiesIfNeeds(List entityList) { // internal
if (entityList == null) {
throw new IllegalArgumentException("The argument 'entityList' should not be null.");
}
if (_updateColumnSpecification != null) {
return; // already specified
}
if (entityList.isEmpty()) {
return; // do nothing
}
if (xisCompatibleBatchUpdateDefaultEveryColumn()) {
return; // every column for compatible
}
final Entity firstEntity = entityList.get(0);
final Set targetProps = xgatherUpdateColumnModifiedProperties(entityList, firstEntity);
final DBMeta dbmeta = firstEntity.asDBMeta();
specify(new SpecifyQuery() {
public void specify(CB cb) {
// you don't need to specify primary key because primary key has special handling
for (String prop : targetProps) {
final ColumnInfo info = dbmeta.findColumnInfo(prop);
if (!info.isPrimary()) { // except PK
cb.localSp().xspecifyColumn(info.getColumnDbName());
}
}
}
});
}
public void xallowUpdateColumnModifiedPropertiesFragmented() { // might be called by generator for option
_updateColumnModifiedPropertiesFragmentedAllowed = true;
}
public void xdisallowUpdateColumnModifiedPropertiesFragmented() { // for back to default
_updateColumnModifiedPropertiesFragmentedAllowed = false;
}
public boolean xisUpdateColumnModifiedPropertiesFragmentedAllowed() {
return _updateColumnModifiedPropertiesFragmentedAllowed;
}
protected Set xgatherUpdateColumnModifiedProperties(List entityList, Entity firstEntity) {
// no use for now (same-set columns basis)
//if (firstEntity.createdBySelect() || ...) { // ...
if (xisUpdateColumnModifiedPropertiesFragmentedAllowed()) { // least common multiple
final Set mergedProps = new LinkedHashSet();
for (Entity entity : entityList) { // for merge
mergedProps.addAll(entity.mymodifiedProperties());
}
return mergedProps;
} else { // same-set columns (mainly here)
final Set firstProps = firstEntity.mymodifiedProperties();
for (Entity entity : entityList) { // for check
if (!entity.mymodifiedProperties().equals(firstProps)) {
throwBatchUpdateColumnModifiedPropertiesFragmentedException(firstProps, entity);
}
}
return firstProps; // use first entity's
}
}
protected void throwBatchUpdateColumnModifiedPropertiesFragmentedException(Set baseProps, Entity entity) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The modified properties in the entity are fragmented as batch update column.");
br.addItem("Advice");
br.addElement("You should specify the same-set columns to your entities.");
br.addElement("For example:");
br.addElement("");
br.addElement(" (x): (BatchUpdate)");
br.addElement(" for (... : ...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberName(\"foo\");");
br.addElement(" if (...) { // only a part of entities is set");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" }");
br.addElement(" member.setVersionNo(...);");
br.addElement(" memberList.add(member);");
br.addElement(" }");
br.addElement(" memberBhv.batchUpdate(memberList); // throws exception");
br.addElement(" (o): (BatchUpdate)");
br.addElement(" for (... : ...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberName(\"foo\");");
br.addElement(" if (...) {");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" } else {");
br.addElement(" member.setMemberStatusCode_Provisional();");
br.addElement(" }");
br.addElement(" member.setVersionNo(...);");
br.addElement(" memberList.add(member);");
br.addElement(" }");
br.addElement(" memberBhv.batchUpdate(memberList); // MEMBER_STATUS_CODE is updated");
br.addElement(" (o): (EntityUpdate)");
br.addElement(" for (... : ...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberName(\"foo\");");
br.addElement(" if (...) { // only a part of entities is set");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" }");
br.addElement(" member.setVersionNo(...);");
br.addElement(" memberList.add(member);");
br.addElement(" }");
br.addElement(" for (Member member : memberList) {");
br.addElement(" memberBhv.update(member); // keep or update new value of MEMBER_STATUS_CODE");
br.addElement(" }");
br.addItem("Update Table");
br.addElement(entity.asDBMeta().getTableDbName());
br.addItem("Base Properties");
br.addElement(baseProps);
br.addItem("Fragmented Entity");
br.addElement(entity.asDBMeta().extractPrimaryKeyMap(entity));
br.addItem("Fragmented Properties");
br.addElement(entity.mymodifiedProperties());
final String msg = br.buildExceptionMessage();
throw new BatchUpdateColumnModifiedPropertiesFragmentedException(msg);
}
// -----------------------------------------------------
// Compatible UpdateColumn
// -----------------------
// for BatchUpdate
public void xtoBeCompatibleBatchUpdateDefaultEveryColumn() {
_compatibleBatchUpdateDefaultEveryColumn = true;
}
public boolean xisCompatibleBatchUpdateDefaultEveryColumn() {
return _compatibleBatchUpdateDefaultEveryColumn;
}
// -----------------------------------------------------
// Update Process
// --------------
public void xcheckSpecifiedUpdateColumnPrimaryKey() { // checked later by process if it needs
if (_updateColumnSpecification == null) {
return;
}
assertUpdateColumnSpecifiedCB();
final CB cb = _updateColumnSpecifiedCB;
final String basePointAliasName = cb.getSqlClause().getBasePointAliasName();
final DBMeta dbmeta = cb.asDBMeta();
if (dbmeta.hasPrimaryKey()) {
final PrimaryInfo pkInfo = dbmeta.getPrimaryInfo();
final List pkList = pkInfo.getPrimaryColumnList();
for (ColumnInfo pk : pkList) {
final String columnDbName = pk.getColumnDbName();
if (cb.getSqlClause().hasSpecifiedSelectColumn(basePointAliasName, columnDbName)) {
String msg = "PK columns should not be allowed to specify as update columns: " + columnDbName;
throw new SpecifyUpdateColumnInvalidException(msg);
}
}
}
}
public boolean hasSpecifiedUpdateColumn() {
return _updateColumnSpecification != null;
}
public CB getUpdateColumnSpecifiedCB() { // for various determination
return _updateColumnSpecifiedCB; // null allowed
}
public boolean isSpecifiedUpdateColumn(String columnDbName) {
if (_forcedSpecifiedUpdateColumnSet != null && _forcedSpecifiedUpdateColumnSet.contains(columnDbName)) {
return true; // basically common column
}
assertUpdateColumnSpecifiedCB();
final SqlClause sqlClause = _updateColumnSpecifiedCB.getSqlClause();
return sqlClause.hasSpecifiedSelectColumn(sqlClause.getBasePointAliasName(), columnDbName);
}
protected void assertUpdateColumnSpecifiedCB() {
if (_updateColumnSpecifiedCB == null) {
String msg = "The CB for specification of update columns should be required here.";
throw new IllegalStateException(msg);
}
}
// ===================================================================================
// Unique By
// =========
/**
* To be unique by the unique column of the unique info.
* The values of the unique columns should be in your entity.
* Usually you can use entity's uniqueOf() so this is basically for interface dispatch world.
* You can update the entity by the key when entity update (NOT batch update).
* @param uniqueInfo The unique info of DB meta for natural unique. (NotNull, NotPrimary)
*/
public void uniqueBy(UniqueInfo uniqueInfo) {
if (uniqueInfo == null) {
String msg = "The argument 'uniqueInfo' should not be null.";
throw new IllegalArgumentException(msg);
}
if (uniqueInfo.isPrimary()) {
String msg = "The unique info should be natural unique (not primary): " + uniqueInfo;
throw new IllegalArgumentException(msg);
}
_uniqueByUniqueInfo = uniqueInfo;
}
public boolean hasUniqueByUniqueInfo() {
return _uniqueByUniqueInfo != null;
}
public UniqueInfo getUniqueByUniqueInfo() {
return _uniqueByUniqueInfo;
}
// ===================================================================================
// Common Column
// =============
/**
* Disable auto-setup for common columns.
* You can update by your values for common columns.
*
* Member member = new Member();
* member.setMemberId(3);
* member.setOthers...(value);
* member.setUpdateDatetime(updateDatetime);
* member.setUpdateUser(updateUser);
* UpdateOption<MemberCB> option = new UpdateOption<MemberCB>();
* option.disableCommonColumnAutoSetup();
* memberBhv.varyingUpdate(member, option);
*
* @return The option of update. (NotNull: returns this)
*/
public UpdateOption disableCommonColumnAutoSetup() {
_disableCommonColumnAutoSetup = true;
return this;
}
public boolean isCommonColumnAutoSetupDisabled() {
return _disableCommonColumnAutoSetup;
}
// ===================================================================================
// Query Update
// ============
/**
* Allow you to non-query-update (means query-update without a query condition).
* Normally it is not allowed, so you can do it by this option if you want.
* @return The option of update. (NotNull: returns this)
*/
public UpdateOption allowNonQueryUpdate() {
_nonQueryUpdateAllowed = true;
return this;
}
public boolean isNonQueryUpdateAllowed() {
return _nonQueryUpdateAllowed;
}
/**
* Allow you to use direct clause in query update forcedly.
* @return The option of update. (NotNull: returns this)
*/
public UpdateOption allowQueryUpdateForcedDirect() {
_queryUpdateForcedDirectAllowed = true;
return this;
}
public boolean isQueryUpdateForcedDirectAllowed() {
return _queryUpdateForcedDirectAllowed;
}
// ===================================================================================
// Batch Logging
// =============
/**
* Limit batch-update logging by logging size.
* For example, if you set 3, only 3 records are logged.
* This also works to SqlLogHandler's call-back and SqlResultInfo's displaySql.
* @param batchLoggingUpdateLimit The limit size of batch-update logging. (NullAllowed: if null and minus, means no limit)
*/
public void limitBatchUpdateLogging(Integer batchLoggingUpdateLimit) {
_batchLoggingUpdateLimit = batchLoggingUpdateLimit;
}
public Integer getBatchUpdateLoggingLimit() {
return _batchLoggingUpdateLimit;
}
// ===================================================================================
// InsertOrUpdate Count PreCheck
// =============================
/**
* Pre-check the count before insert-or-update.
* Basically to avoid Otegaru Deadlock of MySQL RepeatableRead.
* @return The option of update. (NotNull: returns this)
*/
public UpdateOption precheckInsertOrUpdateCount() {
_insertOrUpdateCountPreChecked = true;
return this;
}
public boolean isInsertOrUpdateCountPreCheck() {
return _insertOrUpdateCountPreChecked;
}
// ===================================================================================
// Reload PK if UniqueBy
// =====================
/**
* Reload primary key for the unique key after update if you use uniqueBy().
* So you can get primary key from updated entity after update by this option.
* @return this. (NotNull)
*/
public UpdateOption reloadPrimaryKeyIfUniqueBy() {
_reloadPrimaryKeyIfUniqueBy = true;
return this;
}
public boolean isReloadPrimaryKeyIfUniqueBy() {
return _reloadPrimaryKeyIfUniqueBy;
}
// ===================================================================================
// Configure
// =========
/**
* Configure statement JDBC options. e.g. queryTimeout, fetchSize, ... (only one-time call)
*
* memberBhv.varyingUpdate(member, op -> op.configure(conf -> conf.queryTimeout(3)));
*
* @param confLambda The callback for configuration of statement for update. (NotNull)
*/
public void configure(StatementConfigCall confLambda) {
assertStatementConfigNotDuplicated(confLambda);
_updateStatementConfig = createStatementConfig(confLambda);
}
protected void assertStatementConfigNotDuplicated(StatementConfigCall configCall) {
if (_updateStatementConfig != null) {
String msg = "Already registered the configuration: existing=" + _updateStatementConfig + ", new=" + configCall;
throw new IllegalConditionBeanOperationException(msg);
}
}
protected StatementConfig createStatementConfig(StatementConfigCall configCall) {
if (configCall == null) {
throw new IllegalArgumentException("The argument 'confLambda' should not be null.");
}
final StatementConfig config = newStatementConfig();
configCall.callback(config);
return config;
}
protected StatementConfig newStatementConfig() {
return new StatementConfig();
}
public StatementConfig getUpdateStatementConfig() {
return _updateStatementConfig;
}
// ===================================================================================
// Basic Override
// ==============
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
if (_selfSpecificationList != null && !_selfSpecificationList.isEmpty()) {
sb.append("SelfCalculationSpecified");
}
if (_updateColumnSpecification != null) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append("UpdateColumnSpecified");
}
if (_disableCommonColumnAutoSetup) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append("CommonColumnDisabled");
}
if (_nonQueryUpdateAllowed) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append("NonQueryUpdateAllowed");
}
if (_batchLoggingUpdateLimit != null) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append("batchLogging(" + _batchLoggingUpdateLimit + ")");
}
if (sb.length() == 0) {
sb.append("default");
}
return DfTypeUtil.toClassTitle(this) + ":{" + sb.toString() + "}";
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy