Package org.hibernate.id.enhanced

Class SequenceStyleGenerator

java.lang.Object

org.hibernate.id.enhanced.SequenceStyleGenerator

All Implemented Interfaces:

ExportableProducer, BulkInsertionCapableIdentifierGenerator, Configurable, IdentifierGenerator, PersistentIdentifierGenerator

public class SequenceStyleGenerator
extends Object
implements PersistentIdentifierGenerator, BulkInsertionCapableIdentifierGenerator

Generates identifier values based on a sequence-style database structure. Variations range from actually using a sequence to using a table to mimic a sequence. These variations are encapsulated by the DatabaseStructure interface internally.

NOTE that by default we utilize a single database sequence for all generators. The configuration parameter CONFIG_PREFER_SEQUENCE_PER_ENTITY can be used to create dedicated sequence for each entity based on its name. Sequence suffix can be controlled with CONFIG_SEQUENCE_PER_ENTITY_SUFFIX option.

General configuration parameters:

NAME	DEFAULT	DESCRIPTION
SEQUENCE_PARAM	DEF_SEQUENCE_NAME	The name of the sequence/table to use to store/retrieve values
INITIAL_PARAM	DEFAULT_INITIAL_VALUE	The initial value to be stored for the given segment; the effect in terms of storage varies based on Optimizer and DatabaseStructure
INCREMENT_PARAM	DEFAULT_INCREMENT_SIZE	The increment size for the underlying segment; the effect in terms of storage varies based on Optimizer and DatabaseStructure
OPT_PARAM	depends on defined increment size	Allows explicit definition of which optimization strategy to use
FORCE_TBL_PARAM	false	Allows explicit definition of which optimization strategy to use

Configuration parameters used specifically when the underlying structure is a table:

NAME	DEFAULT	DESCRIPTION
VALUE_COLUMN_PARAM	DEF_VALUE_COLUMN	The name of column which holds the sequence value for the given segment

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PREFER_SEQUENCE_PER_ENTITY	Used to create dedicated sequence for each entity based on the entity name.
static String	CONFIG_SEQUENCE_PER_ENTITY_SUFFIX	Indicates the suffix to use in naming the identifier sequence/table name, by appending the suffix to the name of the entity.
static String	DEF_SEQUENCE_NAME	The default value for SEQUENCE_PARAM, in the absence of any CONFIG_PREFER_SEQUENCE_PER_ENTITY setting.
static String	DEF_SEQUENCE_SUFFIX	The default value for CONFIG_SEQUENCE_PER_ENTITY_SUFFIX
static String	DEF_VALUE_COLUMN	The default value for VALUE_COLUMN_PARAM
static int	DEFAULT_INCREMENT_SIZE	The default value for INCREMENT_PARAM
static int	DEFAULT_INITIAL_VALUE	The default value for INITIAL_PARAM
static String	FORCE_TBL_PARAM	A flag to force using a table as the underlying structure rather than a sequence.
static String	INCREMENT_PARAM	Indicates the increment size to use.
static String	INITIAL_PARAM	Indicates the initial value to use.
static String	OPT_PARAM	Indicates the optimizer to use, either naming a Optimizer implementation class or naming a StandardOptimizerDescriptor by name
static String	SEQUENCE_PARAM	Indicates the name of the sequence (or table) to use.
static String	VALUE_COLUMN_PARAM	Indicates the name of the column holding the identifier values.

Fields inherited from interface org.hibernate.id.IdentifierGenerator

ENTITY_NAME, GENERATOR_NAME, JPA_ENTITY_NAME

Fields inherited from interface org.hibernate.id.PersistentIdentifierGenerator

CATALOG, IDENTIFIER_NORMALIZER, PK, SCHEMA, TABLE, TABLES

Constructor Summary

Constructors

Constructor	Description
SequenceStyleGenerator()

Method Summary

Modifier and Type	Method	Description
protected DatabaseStructure	buildDatabaseStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, boolean forceTableUse, QualifiedName sequenceName, int initialValue, int incrementSize)	Build the database structure.
protected DatabaseStructure	buildSequenceStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)
protected DatabaseStructure	buildTableStructure(Type type, Properties params, JdbcEnvironment jdbcEnvironment, QualifiedName sequenceName, int initialValue, int incrementSize)
void	configure(Type type, Properties params, ServiceRegistry serviceRegistry)	Configure this instance, given the value of parameters specified by the user as <param> elements.
protected int	determineAdjustedIncrementSize(String optimizationStrategy, int incrementSize)	In certain cases we need to adjust the increment size based on the selected optimizer.
String	determineBulkInsertionIdentifierGenerationSelectFragment(SqlStringGenerationContext context)	Return the select expression fragment, if any, that generates the identifier values.
protected int	determineIncrementSize(Properties params)	Determine the increment size to be applied.
protected int	determineInitialValue(Properties params)	Determine the initial sequence value to use.
protected String	determineOptimizationStrategy(Properties params, int incrementSize)	Determine the optimizer to use.
protected QualifiedName	determineSequenceName(Properties params, Dialect dialect, JdbcEnvironment jdbcEnv, ServiceRegistry serviceRegistry)	Determine the name of the sequence (or table if this resolves to a physical table) to use.
protected Identifier	determineValueColumnName(Properties params, JdbcEnvironment jdbcEnvironment)	Determine the name of the column used to store the generator value in the db.
Serializable	generate(SharedSessionContractImplementor session, Object object)	Generate a new identifier.
Object	generatorKey()	Deprecated.
DatabaseStructure	getDatabaseStructure()	Getter for property 'databaseStructure'.
Type	getIdentifierType()	Getter for property 'identifierType'.
Optimizer	getOptimizer()	Getter for property 'optimizer'.
void	initialize(SqlStringGenerationContext context)	Initializes this instance, in particular pre-generates SQL as necessary.
protected boolean	isPhysicalSequence(JdbcEnvironment jdbcEnvironment, boolean forceTableUse)
void	registerExportables(Database database)	Register database objects used by this identifier generator, e.g.
boolean	supportsBulkInsertionIdentifierGeneration()	Given the configuration of this generator, is identifier generation as part of bulk insertion supported?

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.id.BulkInsertionCapableIdentifierGenerator

determineBulkInsertionIdentifierGenerationSelectFragment

Methods inherited from interface org.hibernate.id.IdentifierGenerator

supportsJdbcBatchInserts

Field Detail

SEQUENCE_PARAM

public static final String SEQUENCE_PARAM

Indicates the name of the sequence (or table) to use. The default value is DEF_SEQUENCE_NAME, although CONFIG_PREFER_SEQUENCE_PER_ENTITY effects the default as well.

See Also:

Constant Field Values

DEF_SEQUENCE_NAME

public static final String DEF_SEQUENCE_NAME

The default value for SEQUENCE_PARAM, in the absence of any CONFIG_PREFER_SEQUENCE_PER_ENTITY setting.

See Also:

Constant Field Values

INITIAL_PARAM

public static final String INITIAL_PARAM

Indicates the initial value to use. The default value is DEFAULT_INITIAL_VALUE

See Also:

Constant Field Values

DEFAULT_INITIAL_VALUE

public static final int DEFAULT_INITIAL_VALUE

The default value for INITIAL_PARAM

See Also:

Constant Field Values

INCREMENT_PARAM

public static final String INCREMENT_PARAM

Indicates the increment size to use. The default value is DEFAULT_INCREMENT_SIZE

See Also:

Constant Field Values

DEFAULT_INCREMENT_SIZE

public static final int DEFAULT_INCREMENT_SIZE

The default value for INCREMENT_PARAM

See Also:

Constant Field Values

CONFIG_PREFER_SEQUENCE_PER_ENTITY

public static final String CONFIG_PREFER_SEQUENCE_PER_ENTITY

Used to create dedicated sequence for each entity based on the entity name. Sequence suffix can be controlled with CONFIG_SEQUENCE_PER_ENTITY_SUFFIX option.

See Also:

Constant Field Values

CONFIG_SEQUENCE_PER_ENTITY_SUFFIX

public static final String CONFIG_SEQUENCE_PER_ENTITY_SUFFIX

Indicates the suffix to use in naming the identifier sequence/table name, by appending the suffix to the name of the entity. Used in conjunction with CONFIG_PREFER_SEQUENCE_PER_ENTITY.

See Also:

Constant Field Values

DEF_SEQUENCE_SUFFIX

public static final String DEF_SEQUENCE_SUFFIX

The default value for CONFIG_SEQUENCE_PER_ENTITY_SUFFIX

See Also:

Constant Field Values

OPT_PARAM

public static final String OPT_PARAM

Indicates the optimizer to use, either naming a Optimizer implementation class or naming a StandardOptimizerDescriptor by name

See Also:

Constant Field Values

FORCE_TBL_PARAM

public static final String FORCE_TBL_PARAM

A flag to force using a table as the underlying structure rather than a sequence.

See Also:

Constant Field Values

VALUE_COLUMN_PARAM

public static final String VALUE_COLUMN_PARAM

Indicates the name of the column holding the identifier values. The default value is DEF_VALUE_COLUMN

See Also:

Constant Field Values

DEF_VALUE_COLUMN

public static final String DEF_VALUE_COLUMN

The default value for VALUE_COLUMN_PARAM

See Also:

Constant Field Values

Constructor Detail

SequenceStyleGenerator

public SequenceStyleGenerator()

Method Detail

getDatabaseStructure

public DatabaseStructure getDatabaseStructure()

Getter for property 'databaseStructure'.

Returns:

Value for property 'databaseStructure'.

getOptimizer

public Optimizer getOptimizer()

Getter for property 'optimizer'.

Returns:

Value for property 'optimizer'.

getIdentifierType

public Type getIdentifierType()

Getter for property 'identifierType'.

Returns:

Value for property 'identifierType'.

configure

public void configure(Type type,
                      Properties params,
                      ServiceRegistry serviceRegistry)
               throws MappingException

Description copied from interface: IdentifierGenerator

Configure this instance, given the value of parameters specified by the user as <param> elements.

This method is called just once, following instantiation, and before IdentifierGenerator.registerExportables(Database).

Specified by:

configure in interface Configurable

Specified by:

configure in interface IdentifierGenerator

Parameters:

type - The id property type descriptor

params - param values, keyed by parameter name

serviceRegistry - Access to service that may be needed.

Throws:

MappingException - If configuration fails.

registerExportables

public void registerExportables(Database database)

Description copied from interface: IdentifierGenerator

Register database objects used by this identifier generator, e.g. sequences, tables, etc.

This method is called just once, after IdentifierGenerator.configure(Type, Properties, ServiceRegistry).

Specified by:

registerExportables in interface ExportableProducer

Specified by:

registerExportables in interface IdentifierGenerator

Parameters:

database - The database instance

initialize

public void initialize(SqlStringGenerationContext context)

Description copied from interface: IdentifierGenerator

Initializes this instance, in particular pre-generates SQL as necessary.

This method is called after IdentifierGenerator.registerExportables(Database), before first use.

Specified by:

initialize in interface IdentifierGenerator

Parameters:

context - A context to help generate SQL strings

determineSequenceName

protected QualifiedName determineSequenceName(Properties params,
                                              Dialect dialect,
                                              JdbcEnvironment jdbcEnv,
                                              ServiceRegistry serviceRegistry)

Determine the name of the sequence (or table if this resolves to a physical table) to use.

Called during configuration.

Parameters:

params - The params supplied in the generator config (plus some standard useful extras).

dialect - The dialect in effect

jdbcEnv - The JdbcEnvironment

Returns:

The sequence name

determineValueColumnName

protected Identifier determineValueColumnName(Properties params,
                                              JdbcEnvironment jdbcEnvironment)

Determine the name of the column used to store the generator value in the db.

Called during configuration when resolving to a physical table.

Parameters:

params - The params supplied in the generator config (plus some standard useful extras).

jdbcEnvironment - The JDBC environment

Returns:

The value column name

determineInitialValue

protected int determineInitialValue(Properties params)

Determine the initial sequence value to use. This value is used when initializing the database structure (i.e. sequence/table).

Called during configuration.

Parameters:

params - The params supplied in the generator config (plus some standard useful extras).

Returns:

The initial value

determineIncrementSize

protected int determineIncrementSize(Properties params)

Determine the increment size to be applied. The exact implications of this value depends on the optimizer being used.

Called during configuration.

Parameters:

params - The params supplied in the generator config (plus some standard useful extras).

Returns:

The increment size

determineOptimizationStrategy

protected String determineOptimizationStrategy(Properties params,
                                               int incrementSize)

Determine the optimizer to use.

Called during configuration.

Parameters:

params - The params supplied in the generator config (plus some standard useful extras).

incrementSize - The determined increment size

Returns:

The optimizer strategy (name)

determineAdjustedIncrementSize

protected int determineAdjustedIncrementSize(String optimizationStrategy,
                                             int incrementSize)

In certain cases we need to adjust the increment size based on the selected optimizer. This is the hook to achieve that.

Parameters:

optimizationStrategy - The optimizer strategy (name)

incrementSize - The determined increment size

Returns:

The adjusted increment size.

buildDatabaseStructure

protected DatabaseStructure buildDatabaseStructure(Type type,
                                                   Properties params,
                                                   JdbcEnvironment jdbcEnvironment,
                                                   boolean forceTableUse,
                                                   QualifiedName sequenceName,
                                                   int initialValue,
                                                   int incrementSize)

Build the database structure.

Parameters:

type - The Hibernate type of the identifier property

params - The params supplied in the generator config (plus some standard useful extras).

jdbcEnvironment - The JDBC environment in which the sequence will be used.

forceTableUse - Should a table be used even if the dialect supports sequences?

sequenceName - The name to use for the sequence or table.

initialValue - The initial value.

incrementSize - the increment size to use (after any adjustments).

Returns:

An abstraction for the actual database structure in use (table vs. sequence).

isPhysicalSequence

protected boolean isPhysicalSequence(JdbcEnvironment jdbcEnvironment,
                                     boolean forceTableUse)

buildSequenceStructure

protected DatabaseStructure buildSequenceStructure(Type type,
                                                   Properties params,
                                                   JdbcEnvironment jdbcEnvironment,
                                                   QualifiedName sequenceName,
                                                   int initialValue,
                                                   int incrementSize)

buildTableStructure

protected DatabaseStructure buildTableStructure(Type type,
                                                Properties params,
                                                JdbcEnvironment jdbcEnvironment,
                                                QualifiedName sequenceName,
                                                int initialValue,
                                                int incrementSize)

generate

public Serializable generate(SharedSessionContractImplementor session,
                             Object object)
                      throws HibernateException

Description copied from interface: IdentifierGenerator

Generate a new identifier.

Specified by:

generate in interface IdentifierGenerator

Parameters:

session - The session from which the request originates

object - the entity or collection (idbag) for which the id is being generated

Returns:

a new identifier

Throws:

HibernateException - Indicates trouble generating the identifier

generatorKey

@Deprecated
public Object generatorKey()

Deprecated.

Description copied from interface: PersistentIdentifierGenerator

Return a key unique to the underlying database objects. Prevents us from trying to create/remove them multiple times.

Specified by:

generatorKey in interface PersistentIdentifierGenerator

Returns:

Object an identifying key for this generator

supportsBulkInsertionIdentifierGeneration

public boolean supportsBulkInsertionIdentifierGeneration()

Description copied from interface: BulkInsertionCapableIdentifierGenerator

Given the configuration of this generator, is identifier generation as part of bulk insertion supported?

IMPL NOTE : Mainly here to allow stuff like SequenceStyleGenerator which *can* support this based on configuration

Specified by:

supportsBulkInsertionIdentifierGeneration in interface BulkInsertionCapableIdentifierGenerator

Returns:

true if bulk insertions are supported; false otherwise.

determineBulkInsertionIdentifierGenerationSelectFragment

public String determineBulkInsertionIdentifierGenerationSelectFragment(SqlStringGenerationContext context)

Description copied from interface: BulkInsertionCapableIdentifierGenerator

Return the select expression fragment, if any, that generates the identifier values.

Specified by:

determineBulkInsertionIdentifierGenerationSelectFragment in interface BulkInsertionCapableIdentifierGenerator

Parameters:

context - A context for SQL string generation.

Returns:

The identifier value generation fragment (SQL). null indicates that no fragment is needed.