org.seasar.doma.jdbc.id

Interface IdGenerator

All Known Subinterfaces:

IdentityIdGenerator, SequenceIdGenerator, TableIdGenerator

All Known Implementing Classes:

AbstractIdGenerator, AbstractPreGenerateIdGenerator, BuiltinIdentityIdGenerator, BuiltinSequenceIdGenerator, BuiltinTableIdGenerator

public interface IdGenerator

An identity generator.

Either generatePreInsert(IdGenerationConfig) or generatePostInsert(IdGenerationConfig, Statement) must return non-null value.

The implementation class must have a public no-args constructor.

The implementation class must be thread safe.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	generatePostInsert(IdGenerationConfig config, java.sql.Statement statement) Generates the identity value after an insert.
java.lang.Long	generatePreInsert(IdGenerationConfig config) Generates the identity value before an insert.
GenerationType	getGenerationType() Returns the generation type.
boolean	includesIdentityColumn(IdGenerationConfig config) Whether this generator includes the identity column into SQL INSERT statements.
boolean	supportsAutoGeneratedKeys(IdGenerationConfig config) Whether this generator supports Statement.getGeneratedKeys().
boolean	supportsBatch(IdGenerationConfig config) Whether this generator supports the batch insert.

Method Detail

supportsBatch

boolean supportsBatch(IdGenerationConfig config)

Whether this generator supports the batch insert.

Parameters:

config - the configuration

Returns:

true if this generator supports

supportsAutoGeneratedKeys

boolean supportsAutoGeneratedKeys(IdGenerationConfig config)

Whether this generator supports Statement.getGeneratedKeys().

Parameters:

config - the configuration

Returns:

true if this generator supports

includesIdentityColumn

boolean includesIdentityColumn(IdGenerationConfig config)

Whether this generator includes the identity column into SQL INSERT statements.

Parameters:

config - the configuration

Returns:

true if supported

generatePreInsert

java.lang.Long generatePreInsert(IdGenerationConfig config)

Generates the identity value before an insert.

Parameters:

config - the configuration

Returns:

the generated value or null if not supported

Throws:

JdbcException - if the generation is failed

generatePostInsert

java.lang.Long generatePostInsert(IdGenerationConfig config,
                                  java.sql.Statement statement)

Generates the identity value after an insert.

Parameters:

config - the configuration

statement - the SQL INSERT statement

Returns:

the generated value or null if not supported

Throws:

JdbcException - if the generation is failed

getGenerationType

GenerationType getGenerationType()

Returns the generation type.

Returns:

the generation type