org.seasar.doma.jdbc.id
インタフェース IdGenerator

既知のサブインタフェースの一覧:

IdentityIdGenerator, SequenceIdGenerator, TableIdGenerator

既知の実装クラスの一覧:

AbstractIdGenerator, AbstractPreGenerateIdGenerator, BuiltinIdentityIdGenerator, BuiltinSequenceIdGenerator, BuiltinTableIdGenerator

public interface IdGenerator

識別子のジェネレータです。

generatePreInsert(IdGenerationConfig) と generatePostInsert(IdGenerationConfig, Statement) のどちらか片方が null ではない値を返さなければいけません。

このインタフェースの実装は、引数なしの public なコンストラクタを持たなければいけません。

このインタフェースの実装はスレッドセーフでなければいけません。

作成者:

taedium

メソッドの概要

Long	generatePostInsert(IdGenerationConfig config, Statement statement) INSERTの実行後に識別子を生成します。
Long	generatePreInsert(IdGenerationConfig config) INSERTの実行前に識別子を生成します。
GenerationType	getGenerationType() 識別子を生成する方法を返します。
boolean	includesIdentityColumn(IdGenerationConfig config) INSERT文にIDENTITYカラムを含めるべきかどうかを返します。
boolean	supportsAutoGeneratedKeys(IdGenerationConfig config) Statement.getGeneratedKeys() をサポートしているかどうかを返します。
boolean	supportsBatch(IdGenerationConfig config) バッチ処理をサポートしているかどうかを返します。

メソッドの詳細

supportsBatch

boolean supportsBatch(IdGenerationConfig config)

バッチ処理をサポートしているかどうかを返します。

パラメータ:

config - 識別子生成の設定

戻り値:

サポートしている場合 true

supportsAutoGeneratedKeys

boolean supportsAutoGeneratedKeys(IdGenerationConfig config)

Statement.getGeneratedKeys() をサポートしているかどうかを返します。

パラメータ:

config - 識別子生成の設定

戻り値:

サポートしている場合 true

includesIdentityColumn

boolean includesIdentityColumn(IdGenerationConfig config)

INSERT文にIDENTITYカラムを含めるべきかどうかを返します。

パラメータ:

config - 識別子生成の設定

戻り値:

サポートしている場合 true

generatePreInsert

Long generatePreInsert(IdGenerationConfig config)

INSERTの実行前に識別子を生成します。

パラメータ:

config - 識別子生成の設定

戻り値:

生成された識別子、サポートしていない場合 null

例外:

JdbcException - 識別子の生成に失敗した場合

generatePostInsert

Long generatePostInsert(IdGenerationConfig config,
                        Statement statement)

INSERTの実行後に識別子を生成します。

パラメータ:

config - 識別子生成の設定

statement - INSERT文を実行した文

戻り値:

生成された識別子、サポートしていない場合 null

例外:

JdbcException - 識別子の生成に失敗した場合

getGenerationType

GenerationType getGenerationType()

識別子を生成する方法を返します。

戻り値:

識別子を生成する方法