Hibernate Core 3.6.10.Final · org.hibernate.id.MultipleHiLoPerTableGenerator

A hilo IdentifierGenerator that returns a Long, constructed using a hi/lo algorithm. The hi value MUST be fetched in a seperate transaction to the Session transaction so the generator must be able to obtain a new connection and commit it. Hence this implementation may not be used when the user is supplying connections. In this case a SequenceHiLoGenerator would be a better choice (where supported).

A hilo IdentifierGenerator that uses a database table to store the last generated values. A table can contains several hi values. They are distinct from each other through a key

This implementation is not compliant with a user connection

Allowed parameters (all of them are optional):

table: table name (default hibernate_sequences)
primary_key_column: key column name (default sequence_name)
value_column: hi value column name(default sequence_next_hi_value)
primary_key_value: key value for the current entity (default to the entity's primary table name)
primary_key_length: length of the key column in DB represented as a varchar (default to 255)
max_lo: max low value before increasing hi (default to Short.MAX_VALUE)

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_PK_COLUMN
private static final int	DEFAULT_PK_LENGTH
public static final String	DEFAULT_TABLE
private static final String	DEFAULT_VALUE_COLUMN
private OptimizerFactory.LegacyHiLoAlgorithmOptimizer	hiloOptimizer
public static final String	ID_TABLE
private String	insert
private int	keySize
private static final Logger	log
public static final String	MAX_LO
private int	maxLo
public static final String	PK_COLUMN_NAME
public static final String	PK_LENGTH_NAME
public static final String	PK_VALUE_NAME
private String	pkColumnName
private String	query
private Class<T>	returnClass
private String	tableName
private String	update
public static final String	VALUE_COLUMN_NAME
private String	valueColumnName

Constructor Summary

Access	Constructor and Description
public	MultipleHiLoPerTableGenerator()

Method Summary

Modifier and Type	Method and Description
public void	configure(Type type, Properties param values, keyed by parameter name params, Dialect dialect) Implements org.hibernate.id.Configurable.configure. Configure this instance, given the value of parameters specified by the user as `<param>` elements.
public Serializable	doWorkInCurrentTransaction(Connection conn, String sql) Implements abstract org.hibernate.engine.TransactionHelper.doWorkInCurrentTransaction. The work to be done
public synchronized Serializable	generate(final SessionImplementor session, Object the entity or toplevel collection for which the id is being generated obj) Implements org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier.
public Object	generatorKey() Implements org.hibernate.id.PersistentIdentifierGenerator.generatorKey. Return a key unique to the underlying database objects.
public String[]	sqlCreateStrings(Dialect The dialect against which to generate the create command(s) dialect) Implements org.hibernate.id.PersistentIdentifierGenerator.sqlCreateStrings. The SQL required to create the underlying database objects.
public String[]	sqlDropStrings(Dialect The dialect against which to generate the drop command(s) dialect) Implements org.hibernate.id.PersistentIdentifierGenerator.sqlDropStrings. The SQL required to remove the underlying database objects.

Inherited from org.hibernate.engine.TransactionHelper:: doWorkInNewTransaction

Field Detail

DEFAULT_PK_COLUMN	back to summary
private static final String DEFAULT_PK_COLUMN

DEFAULT_PK_LENGTH	back to summary
private static final int DEFAULT_PK_LENGTH

DEFAULT_TABLE	back to summary
public static final String DEFAULT_TABLE

DEFAULT_VALUE_COLUMN	back to summary
private static final String DEFAULT_VALUE_COLUMN

hiloOptimizer	back to summary
private OptimizerFactory.LegacyHiLoAlgorithmOptimizer hiloOptimizer

ID_TABLE	back to summary
public static final String ID_TABLE

insert	back to summary
private String insert

keySize	back to summary
private int keySize

log	back to summary
private static final Logger log

MAX_LO	back to summary
public static final String MAX_LO

maxLo	back to summary
private int maxLo

PK_COLUMN_NAME	back to summary
public static final String PK_COLUMN_NAME

PK_LENGTH_NAME	back to summary
public static final String PK_LENGTH_NAME

PK_VALUE_NAME	back to summary
public static final String PK_VALUE_NAME

pkColumnName	back to summary
private String pkColumnName

query	back to summary
private String query

returnClass	back to summary
private Class<T> returnClass

tableName	back to summary
private String tableName

update	back to summary
private String update

VALUE_COLUMN_NAME	back to summary
public static final String VALUE_COLUMN_NAME

valueColumnName	back to summary
private String valueColumnName

Constructor Detail

MultipleHiLoPerTableGenerator	back to summary
public MultipleHiLoPerTableGenerator()

Method Detail

configure back to summary

configure	back to summary
public void configure(Type type, Properties params, Dialect dialect) throws MappingException Implements org.hibernate.id.Configurable.configure. Doc from org.hibernate.id.Configurable.configure. Configure this instance, given the value of parameters specified by the user as `<param>` elements. This method is called just once, following instantiation. Parameters params:Properties param values, keyed by parameter name

public void configure(Type type, Properties params, Dialect dialect) throws MappingException

Implements org.hibernate.id.Configurable.configure.

Doc from org.hibernate.id.Configurable.configure.

Configure this instance, given the value of parameters specified by the user as <param> elements. This method is called just once, following instantiation.

Parameters

params:Properties: param values, keyed by parameter name

doWorkInCurrentTransaction	back to summary
public Serializable doWorkInCurrentTransaction(Connection conn, String sql) throws SQLException Implements abstract org.hibernate.engine.TransactionHelper.doWorkInCurrentTransaction. Doc from org.hibernate.engine.TransactionHelper.doWorkInCurrentTransaction. The work to be done

doWorkInCurrentTransaction

back to summary

public Serializable doWorkInCurrentTransaction(Connection conn, String sql) throws SQLException

Implements abstract org.hibernate.engine.TransactionHelper.doWorkInCurrentTransaction.

Doc from org.hibernate.engine.TransactionHelper.doWorkInCurrentTransaction.

The work to be done

generate	back to summary
public synchronized Serializable generate(final SessionImplementor session, Object obj) throws HibernateException Implements org.hibernate.id.IdentifierGenerator.generate. Doc from org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier. Parameters obj:Object the entity or toplevel collection for which the id is being generated Returns:Serializable a new identifier

generate

back to summary

public synchronized Serializable generate(final SessionImplementor session, Object obj) throws HibernateException

Implements org.hibernate.id.IdentifierGenerator.generate.

Doc from org.hibernate.id.IdentifierGenerator.generate.

Generate a new identifier.

Parameters

obj:Object: the entity or toplevel collection for which the id is being generated

Returns:Serializable

a new identifier

generatorKey	back to summary
public Object generatorKey() Implements org.hibernate.id.PersistentIdentifierGenerator.generatorKey. Doc from org.hibernate.id.PersistentIdentifierGenerator.generatorKey. Return a key unique to the underlying database objects. Prevents us from trying to create/remove them multiple times. Returns:Object Object an identifying key for this generator

generatorKey

back to summary

public Object generatorKey()

Implements org.hibernate.id.PersistentIdentifierGenerator.generatorKey.

Doc from org.hibernate.id.PersistentIdentifierGenerator.generatorKey.

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

Returns:Object: Object an identifying key for this generator

sqlCreateStrings	back to summary
public String[] sqlCreateStrings(Dialect dialect) throws HibernateException Implements org.hibernate.id.PersistentIdentifierGenerator.sqlCreateStrings. Doc from org.hibernate.id.PersistentIdentifierGenerator.sqlCreateStrings. The SQL required to create the underlying database objects. Parameters dialect:Dialect The dialect against which to generate the create command(s) Returns:String[] The create command(s) Exceptions HibernateException: problem creating the create command(s)

sqlCreateStrings

back to summary

public String[] sqlCreateStrings(Dialect dialect) throws HibernateException

Implements org.hibernate.id.PersistentIdentifierGenerator.sqlCreateStrings.

Doc from org.hibernate.id.PersistentIdentifierGenerator.sqlCreateStrings.

The SQL required to create the underlying database objects.

Parameters

dialect:Dialect: The dialect against which to generate the create command(s)

Returns:String[]

The create command(s)

Exceptions

HibernateException:: problem creating the create command(s)

sqlDropStrings	back to summary
public String[] sqlDropStrings(Dialect dialect) throws HibernateException Implements org.hibernate.id.PersistentIdentifierGenerator.sqlDropStrings. Doc from org.hibernate.id.PersistentIdentifierGenerator.sqlDropStrings. The SQL required to remove the underlying database objects. Parameters dialect:Dialect The dialect against which to generate the drop command(s) Returns:String[] The drop command(s) Exceptions HibernateException: problem creating the drop command(s)

sqlDropStrings

back to summary

public String[] sqlDropStrings(Dialect dialect) throws HibernateException

Implements org.hibernate.id.PersistentIdentifierGenerator.sqlDropStrings.

Doc from org.hibernate.id.PersistentIdentifierGenerator.sqlDropStrings.

The SQL required to remove the underlying database objects.

Parameters

dialect:Dialect: The dialect against which to generate the drop command(s)

Returns:String[]

The drop command(s)

Exceptions

HibernateException:: problem creating the drop command(s)

public Class MultipleHiLoPerTableGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail