InsertOption (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.bhv.writable.InsertOption<CB>

型パラメータ:

CB - The type of condition-bean for specification.

すべての実装されたインタフェース:

WritableOption<CB>
```
public class InsertOption<CB extends ConditionBean>
extends Object
implements WritableOption<CB>
```
The option of insert for varying-insert.

導入されたバージョン:

0.9.7.8 (2010/12/16 Thursday)

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected Integer`	`_batchInsertLoggingLimit`
`protected boolean`	`_compatibleBatchInsertDefaultEveryColumn`
`protected boolean`	`_compatibleInsertColumnNotNullOnly`
`protected boolean`	`_disableCommonColumnAutoSetup`
`protected boolean`	`_disablePrimaryKeyIdentity`
`protected boolean`	`_exceptCommonColumnForcedSpecified`
`protected Set<String>`	`_forcedSpecifiedInsertColumnSet`
`protected boolean`	`_insertColumnModifiedPropertiesFragmentedAllowed`
`protected SpecifyQuery<CB>`	`_insertColumnSpecification`
`protected CB`	`_insertColumnSpecifiedCB`
`protected StatementConfig`	`_insertStatementConfig`
`static Long`	`VERSION_NO_FIRST_VALUE`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

InsertOption()
Constructor.

コンストラクタ
コンストラクタと説明
`InsertOption()` Constructor.

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`addForcedSpecifiedInsertColumn(ColumnInfo columnInfo)`
`protected void`	`assertInsertColumnSpecifiedCB()`
`protected void`	`assertStatementConfigNotDuplicated(StatementConfigCall<StatementConfig> configCall)`
`void`	`configure(StatementConfigCall<StatementConfig> confLambda)` Configure statement JDBC options. e.g. queryTimeout, fetchSize, ...
`protected StatementConfig`	`createStatementConfig(StatementConfigCall<StatementConfig> configCall)`
`InsertOption<CB>`	`disableCommonColumnAutoSetup()` Disable auto-setup for common columns.
`InsertOption<CB>`	`disablePrimaryKeyIdentity()` Disable identity for primary key.
`InsertOption<CB>`	`exceptCommonColumnForcedSpecified()` Except common columns from forced specified insert columns.
`Integer`	`getBatchInsertLoggingLimit()`
`StatementConfig`	`getInsertStatementConfig()`
`boolean`	`hasSpecifiedInsertColumn()`
`boolean`	`isCommonColumnAutoSetupDisabled()`
`boolean`	`isPrimaryKeyIdentityDisabled()`
`boolean`	`isSpecifiedInsertColumn(String columnDbName)`
`void`	`limitBatchInsertLogging(Integer batchInsertLoggingLimit)` Limit batch-insert logging by logging size.
`protected StatementConfig`	`newStatementConfig()`
`void`	`resolveInsertColumnSpecification(CB cb)`
`void`	`specify(SpecifyQuery<CB> insertColumnSpecification)` Specify insert columns manually.
`protected void`	`throwBatchInsertColumnModifiedPropertiesFragmentedException(Set<String> baseProps, Entity entity)`
`String`	`toString()`
`protected void`	`xacceptCommonColumnForcedSpecification(CB cb)`
`void`	`xacceptInsertColumnModifiedPropertiesIfNeeds(List<? extends Entity> entityList)`
`void`	`xallowInsertColumnModifiedPropertiesFragmented()`
`void`	`xcheckSpecifiedInsertColumnPrimaryKey()`
`void`	`xdisallowInsertColumnModifiedPropertiesFragmented()`
`protected Set<String>`	`xgatherInsertColumnModifiedProperties(List<? extends Entity> entityList, Entity firstEntity)`
`boolean`	`xisCompatibleBatchInsertDefaultEveryColumn()`
`boolean`	`xisCompatibleInsertColumnNotNullOnly()`
`boolean`	`xisInsertColumnModifiedPropertiesFragmentedAllowed()`
`void`	`xtoBeCompatibleBatchInsertDefaultEveryColumn()`
`void`	`xtoBeCompatibleInsertColumnNotNullOnly()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

VERSION_NO_FIRST_VALUE

public static final Long VERSION_NO_FIRST_VALUE

_insertColumnSpecification

protected SpecifyQuery<CB extends ConditionBean> _insertColumnSpecification

_insertColumnSpecifiedCB

protected CB extends ConditionBean _insertColumnSpecifiedCB

_forcedSpecifiedInsertColumnSet

protected Set<String> _forcedSpecifiedInsertColumnSet

_exceptCommonColumnForcedSpecified

protected boolean _exceptCommonColumnForcedSpecified

_insertColumnModifiedPropertiesFragmentedAllowed

protected boolean _insertColumnModifiedPropertiesFragmentedAllowed

_compatibleBatchInsertDefaultEveryColumn

protected boolean _compatibleBatchInsertDefaultEveryColumn

_compatibleInsertColumnNotNullOnly

protected boolean _compatibleInsertColumnNotNullOnly

_disableCommonColumnAutoSetup

protected boolean _disableCommonColumnAutoSetup

_disablePrimaryKeyIdentity

protected boolean _disablePrimaryKeyIdentity

_batchInsertLoggingLimit

protected Integer _batchInsertLoggingLimit

_insertStatementConfig

protected StatementConfig _insertStatementConfig

コンストラクタの詳細

InsertOption

public InsertOption()

Constructor.

 Member member = new Member();
 member.set...(value);
 InsertOption<MemberCB> option = new InsertOption<MemberCB>();
 
 // e.g. you can insert by your values for common columns
 option.disableCommonColumnAutoSetup();
 
 // e.g. you can insert by your values for primary key
 option.disablePrimaryKeyIdentity();
 
 memberBhv.varyingInsert(member, option);

メソッドの詳細

specify

public void specify(SpecifyQuery<CB> insertColumnSpecification)

Specify insert columns manually.
You can insert fixed columns instead of modified update columns.

 Member member = new Member();
 member.setMemberId(3);
 member.setOthers...(value);
 InsertOption<MemberCB> option = new InsertOption<MemberCB>();
 option.specify(new SpecifyQuery<MemberCB>() {
     public void query(MemberCB cb) {
         // only MemberName and Birthdate are updated
         // with common columns for update and an exclusive control column
         cb.specify().columnMemberName();
         cb.specify().columnBirthdate();
     }
 });
 memberBhv.varyingUpdate(member, option);

パラメータ:: insertColumnSpecification - The query for specifying insert columns. (NotNull)

resolveInsertColumnSpecification

public void resolveInsertColumnSpecification(CB cb)

exceptCommonColumnForcedSpecified
```
public InsertOption<CB> exceptCommonColumnForcedSpecified()
```
Except common columns from forced specified insert columns.

戻り値:

The option of insert. (NotNull: returns this)

xacceptCommonColumnForcedSpecification

protected void xacceptCommonColumnForcedSpecification(CB cb)

addForcedSpecifiedInsertColumn

protected void addForcedSpecifiedInsertColumn(ColumnInfo columnInfo)

xacceptInsertColumnModifiedPropertiesIfNeeds

public void xacceptInsertColumnModifiedPropertiesIfNeeds(List<? extends Entity> entityList)

xallowInsertColumnModifiedPropertiesFragmented

public void xallowInsertColumnModifiedPropertiesFragmented()

xdisallowInsertColumnModifiedPropertiesFragmented

public void xdisallowInsertColumnModifiedPropertiesFragmented()

xisInsertColumnModifiedPropertiesFragmentedAllowed

public boolean xisInsertColumnModifiedPropertiesFragmentedAllowed()

xgatherInsertColumnModifiedProperties

protected Set<String> xgatherInsertColumnModifiedProperties(List<? extends Entity> entityList,
                                                            Entity firstEntity)

throwBatchInsertColumnModifiedPropertiesFragmentedException

protected void throwBatchInsertColumnModifiedPropertiesFragmentedException(Set<String> baseProps,
                                                                           Entity entity)

xtoBeCompatibleBatchInsertDefaultEveryColumn

public void xtoBeCompatibleBatchInsertDefaultEveryColumn()

xisCompatibleBatchInsertDefaultEveryColumn

public boolean xisCompatibleBatchInsertDefaultEveryColumn()

xtoBeCompatibleInsertColumnNotNullOnly

public void xtoBeCompatibleInsertColumnNotNullOnly()

xisCompatibleInsertColumnNotNullOnly

public boolean xisCompatibleInsertColumnNotNullOnly()

xcheckSpecifiedInsertColumnPrimaryKey

public void xcheckSpecifiedInsertColumnPrimaryKey()

hasSpecifiedInsertColumn

public boolean hasSpecifiedInsertColumn()

isSpecifiedInsertColumn

public boolean isSpecifiedInsertColumn(String columnDbName)

assertInsertColumnSpecifiedCB

protected void assertInsertColumnSpecifiedCB()

disableCommonColumnAutoSetup

public InsertOption<CB> disableCommonColumnAutoSetup()

Disable auto-setup for common columns.
You can insert by your values for common columns.

 Member member = new Member();
 member.setOthers...(value);
 member.setRegisterDatetime(registerDatetime);
 member.setRegisterUser(registerUser);
 member.setUpdateDatetime(updateDatetime);
 member.setUpdateUser(updateUser);
 InsertOption<MemberCB> option = new InsertOption<MemberCB>();
 option.disableCommonColumnAutoSetup();
 memberBhv.varyingInsert(member, option);

戻り値:: The option of insert. (NotNull: returns this)

isCommonColumnAutoSetupDisabled

public boolean isCommonColumnAutoSetupDisabled()

disablePrimaryKeyIdentity

public InsertOption<CB> disablePrimaryKeyIdentity()

Disable identity for primary key.
you can insert by your value for primary key.

 Member member = new Member();
 member.setMemberId(123); // instead of identity
 member.setOthers...(value);
 InsertOption<MemberCB> option = new InsertOption<MemberCB>();
 option.disablePrimaryKeyIdentity();
 memberBhv.varyingInsert(member, option);

戻り値:: The option of insert. (NotNull: returns this)

isPrimaryKeyIdentityDisabled

public boolean isPrimaryKeyIdentityDisabled()

limitBatchInsertLogging
```
public void limitBatchInsertLogging(Integer batchInsertLoggingLimit)
```
Limit batch-insert 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.

パラメータ:

batchInsertLoggingLimit - The limit size of batch-insert logging. (NullAllowed: if null and minus, means no limit)

getBatchInsertLoggingLimit

public Integer getBatchInsertLoggingLimit()

configure
```
public void configure(StatementConfigCall<StatementConfig> confLambda)
```
Configure statement JDBC options. e.g. queryTimeout, fetchSize, ... (only one-time call)
```
 memberBhv.varyingInsert(member, op -> op.configure(conf -> conf.queryTimeout(3)));
 
```
パラメータ:

confLambda - The callback for configuration of statement for insert. (NotNull)

assertStatementConfigNotDuplicated

protected void assertStatementConfigNotDuplicated(StatementConfigCall<StatementConfig> configCall)

createStatementConfig

protected StatementConfig createStatementConfig(StatementConfigCall<StatementConfig> configCall)

newStatementConfig

protected StatementConfig newStatementConfig()

getInsertStatementConfig

public StatementConfig getInsertStatementConfig()

toString
```
public String toString()
```
オーバーライド:

toString クラス内 Object

クラス InsertOption<CB extends ConditionBean>