org.jminor.framework.domain

Interface Entity.KeyGenerator

Enclosing interface:

Entity

public static interface Entity.KeyGenerator

Generates primary key values for entities on insert. KeyGenerators fall into two categories, one in which the primary key value is fetched or generated before the record is inserted and one where the underlying database automatically sets the primary key value on insert, f.ex. with a table trigger or identity columns. Implementations should override either beforeInsert() or afterInsert(). isAutoIncrement() returns true if the database generates primary key values automatically, this implies that afterInsert() should be used, fetching the generated primary key value and updating the entity instance accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Entity.KeyGenerator.Type The possible key generation strategy types

Method Summary

Modifier and Type	Method and Description
default void	afterInsert(Entity entity, DatabaseConnection connection, java.sql.Statement insertStatement) Prepares the given entity after insert, that is, fetches automatically generated primary key values and populates the entitys primary key.
default void	beforeInsert(Entity entity, DatabaseConnection connection) Prepares the given entity for insert, that is, generates and fetches any required primary key values and populates the entitys primary key.
Entity.KeyGenerator.Type	getType()
default boolean	returnPrimaryKeyValues() Specifies whether the insert statement should return the primary key column values via the resulting Statement.getGeneratedKeys() resultSet, accessible in afterInsert(Entity, DatabaseConnection, Statement).

Method Detail

beforeInsert

default void beforeInsert(Entity entity,
                          DatabaseConnection connection)
                   throws java.sql.SQLException

Prepares the given entity for insert, that is, generates and fetches any required primary key values and populates the entitys primary key. The default version does nothing, override to implement.

Parameters:

entity - the entity to prepare

connection - the connection to use

Throws:

java.sql.SQLException - in case of an exception

afterInsert

default void afterInsert(Entity entity,
                         DatabaseConnection connection,
                         java.sql.Statement insertStatement)
                  throws java.sql.SQLException

Prepares the given entity after insert, that is, fetches automatically generated primary key values and populates the entitys primary key. The default version does nothing, override to implement.

Parameters:

entity - the entity to prepare

connection - the connection to use

insertStatement - the insert statement

Throws:

java.sql.SQLException - in case of an exception

returnPrimaryKeyValues

default boolean returnPrimaryKeyValues()

Specifies whether the insert statement should return the primary key column values via the resulting Statement.getGeneratedKeys() resultSet, accessible in afterInsert(Entity, DatabaseConnection, Statement). The default implementation returns false.

Returns:

true if the primary key column values should be returned via the insert statement resultSet

See Also:

Connection.prepareStatement(String, String[])

getType

Entity.KeyGenerator.Type getType()

Returns:

the key generator type