Package org.hibernate.id

Class IncrementGenerator

java.lang.Object

org.hibernate.id.IncrementGenerator

All Implemented Interfaces:

ExportableProducer, Configurable, IdentifierGenerator

public class IncrementGenerator
extends java.lang.Object
implements IdentifierGenerator

increment

An IdentifierGenerator that returns a long, constructed by counting from the maximum primary key value at startup. Not safe for use in a cluster!

Mapping parameters supported, but not usually needed: tables, column. (The tables parameter specified a comma-separated list of table names.)

Field Summary

Fields inherited from interface org.hibernate.id.IdentifierGenerator

ENTITY_NAME, GENERATOR_NAME, JPA_ENTITY_NAME

Constructor Summary

Constructors

Constructor	Description
IncrementGenerator()

Method Summary

Modifier and Type	Method	Description
void	configure(Type type, java.util.Properties params, ServiceRegistry serviceRegistry)	Configure this instance, given the value of parameters specified by the user as <param> elements.
java.io.Serializable	generate(SharedSessionContractImplementor session, java.lang.Object object)	Generate a new identifier.
java.lang.String[]	getAllSqlForTests()	Deprecated. Exposed for tests only.
void	initialize(SqlStringGenerationContext context)	Initializes this instance, in particular pre-generates SQL as necessary.

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.IdentifierGenerator

registerExportables, supportsJdbcBatchInserts

Constructor Detail

IncrementGenerator

public IncrementGenerator()

Method Detail

getAllSqlForTests

@Deprecated
public java.lang.String[] getAllSqlForTests()

Deprecated.

Exposed for tests only.

generate

public java.io.Serializable generate(SharedSessionContractImplementor session,
                                     java.lang.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

configure

public void configure(Type type,
                      java.util.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.

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