org.seasar.doma.jdbc.id

Class AbstractPreGenerateIdGenerator

java.lang.Object

org.seasar.doma.jdbc.id.AbstractIdGenerator

org.seasar.doma.jdbc.id.AbstractPreGenerateIdGenerator

All Implemented Interfaces:

IdGenerator

Direct Known Subclasses:

BuiltinSequenceIdGenerator, BuiltinTableIdGenerator

public abstract class AbstractPreGenerateIdGenerator
extends AbstractIdGenerator

A generator that generates an identity value before an execution of insert.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractPreGenerateIdGenerator.IdContext A context for identity values.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	allocationSize
protected java.util.concurrent.ConcurrentMap<java.lang.String,AbstractPreGenerateIdGenerator.IdContext>	idContextMap
protected long	initialValue

Constructor Summary

Constructors

Constructor and Description
AbstractPreGenerateIdGenerator()

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.
protected AbstractPreGenerateIdGenerator.IdContext	getIdContext(IdGenerationConfig config) Returns the identity context.
protected abstract long	getNewInitialValue(IdGenerationConfig config) Return the next initial value.
boolean	includesIdentityColumn(IdGenerationConfig config) Whether this generator includes the identity column into SQL INSERT statements.
void	setAllocationSize(long allocationSize) Sets the allocation size.
void	setInitialValue(long initialValue) Sets the initial value.
boolean	supportsAutoGeneratedKeys(IdGenerationConfig config) Whether this generator supports Statement.getGeneratedKeys().
boolean	supportsBatch(IdGenerationConfig config) Whether this generator supports the batch insert.

Methods inherited from class org.seasar.doma.jdbc.id.AbstractIdGenerator

getGeneratedValue, getGeneratedValue, setupOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.seasar.doma.jdbc.id.IdGenerator

getGenerationType

Field Detail

initialValue

protected long initialValue

allocationSize

protected long allocationSize

idContextMap

protected final java.util.concurrent.ConcurrentMap<java.lang.String,AbstractPreGenerateIdGenerator.IdContext> idContextMap

Constructor Detail

AbstractPreGenerateIdGenerator

public AbstractPreGenerateIdGenerator()

Method Detail

setInitialValue

public void setInitialValue(long initialValue)

Sets the initial value.

Parameters:

initialValue - the initial value

setAllocationSize

public void setAllocationSize(long allocationSize)

Sets the allocation size.

Parameters:

allocationSize - the allocation size

supportsBatch

public boolean supportsBatch(IdGenerationConfig config)

Description copied from interface: IdGenerator

Whether this generator supports the batch insert.

Parameters:

config - the configuration

Returns:

true if this generator supports

supportsAutoGeneratedKeys

public boolean supportsAutoGeneratedKeys(IdGenerationConfig config)

Description copied from interface: IdGenerator

Whether this generator supports Statement.getGeneratedKeys().

Parameters:

config - the configuration

Returns:

true if this generator supports

includesIdentityColumn

public boolean includesIdentityColumn(IdGenerationConfig config)

Description copied from interface: IdGenerator

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

Parameters:

config - the configuration

Returns:

true if supported

generatePreInsert

public java.lang.Long generatePreInsert(IdGenerationConfig config)

Description copied from interface: IdGenerator

Generates the identity value before an insert.

Parameters:

config - the configuration

Returns:

the generated value or null if not supported

generatePostInsert

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

Description copied from interface: IdGenerator

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

getIdContext

protected AbstractPreGenerateIdGenerator.IdContext getIdContext(IdGenerationConfig config)

Returns the identity context.

Parameters:

config - the configuration

Returns:

the identity context

getNewInitialValue

protected abstract long getNewInitialValue(IdGenerationConfig config)

Return the next initial value.

Parameters:

config - the configuration

Returns:

the new initial value

Throws:

JdbcException - if it fails to retrieve the next initial value.