com.atlassian.hibernate.extras

Class ResettableTableHiLoGenerator

java.lang.Object

org.hibernate.engine.TransactionHelper

org.hibernate.id.TableGenerator

com.atlassian.hibernate.extras.ResettableTableHiLoGenerator

All Implemented Interfaces:

org.hibernate.id.Configurable, org.hibernate.id.IdentifierGenerator, org.hibernate.id.PersistentIdentifierGenerator

public class ResettableTableHiLoGenerator
extends org.hibernate.id.TableGenerator

An implementation of a resettable hi/lo IdentifierGenerator which is compatible with Hibernate 3.

hilo

An IdentifierGenerator that returns a Long, constructed using a hi/lo algorithm. The hi value MUST be fetched in a separate 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).

Mapping parameters supported: table, column, max_lo

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_LO The max_lo parameter

Fields inherited from class org.hibernate.id.TableGenerator

COLUMN, DEFAULT_COLUMN_NAME, DEFAULT_TABLE_NAME, TABLE

Fields inherited from interface org.hibernate.id.PersistentIdentifierGenerator

CATALOG, IDENTIFIER_NORMALIZER, PK, SCHEMA, SQL_STATEMENT_LOGGER, TABLES

Fields inherited from interface org.hibernate.id.IdentifierGenerator

ENTITY_NAME

Constructor Summary

Constructors

Constructor and Description
ResettableTableHiLoGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.hibernate.type.Type type, Properties params, org.hibernate.dialect.Dialect d)
Serializable	generate(org.hibernate.engine.SessionImplementor session, Object obj)
int	getMaxLo() Get the max_lo value, so that we can calculate a valid value for the next_hi DB value, given the ids already allocated in the database.
void	reset() Set the lo value to more than maxLo to force a reset of the hi value.
String[]	sqlCreateStrings(org.hibernate.dialect.Dialect dialect)

Methods inherited from class org.hibernate.id.TableGenerator

buildHolder, doWorkInCurrentTransaction, generateHolder, generatorKey, sqlDropStrings

Methods inherited from class org.hibernate.engine.TransactionHelper

doWorkInNewTransaction

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LO

public static final String MAX_LO

The max_lo parameter

See Also:

Constant Field Values

Constructor Detail

ResettableTableHiLoGenerator

public ResettableTableHiLoGenerator()

Method Detail

configure

public void configure(org.hibernate.type.Type type,
             Properties params,
             org.hibernate.dialect.Dialect d)

Specified by:

configure in interface org.hibernate.id.Configurable

Overrides:

configure in class org.hibernate.id.TableGenerator

generate

public Serializable generate(org.hibernate.engine.SessionImplementor session,
                    Object obj)
                      throws org.hibernate.HibernateException

Specified by:

generate in interface org.hibernate.id.IdentifierGenerator

Overrides:

generate in class org.hibernate.id.TableGenerator

Throws:

org.hibernate.HibernateException

reset

public void reset()

Set the lo value to more than maxLo to force a reset of the hi value.

sqlCreateStrings

public String[] sqlCreateStrings(org.hibernate.dialect.Dialect dialect)

Specified by:

sqlCreateStrings in interface org.hibernate.id.PersistentIdentifierGenerator

Overrides:

sqlCreateStrings in class org.hibernate.id.TableGenerator

getMaxLo

public int getMaxLo()

Get the max_lo value, so that we can calculate a valid value for the next_hi DB value, given the ids already allocated in the database.