org.hibernate.id

Interface IdentifierGenerator

All Known Subinterfaces:

BulkInsertionCapableIdentifierGenerator, PersistentIdentifierGenerator, PostInsertIdentifierGenerator

All Known Implementing Classes:

AbstractPostInsertGenerator, AbstractUUIDGenerator, Assigned, CompositeNestedGeneratedValueGenerator, ForeignGenerator, GUIDGenerator, IdentityGenerator, IncrementGenerator, MultipleHiLoPerTableGenerator, SelectGenerator, SequenceGenerator, SequenceHiLoGenerator, SequenceIdentityGenerator, SequenceStyleGenerator, TableGenerator, UUIDGenerator, UUIDHexGenerator

public interface IdentifierGenerator

The general contract between a class that generates unique identifiers and the <tt>Session</tt>. It is not intended that this interface ever be exposed to the application. It <b>is</b> intended that users implement this interface to provide custom identifier generation strategies.<br> <br> Implementors should provide a public default constructor.<br> <br> Implementations that accept configuration parameters should also implement <tt>Configurable</tt>. <br> Implementors <em>must</em> be thread-safe

See Also:

PersistentIdentifierGenerator, Configurable

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_NAME The configuration parameter holding the entity name
static String	GENERATOR_NAME Used as a key to pass the name used as GeneratedValue.generator() to the IdentifierGenerator as it is configured.
static String	JPA_ENTITY_NAME The configuration parameter holding the JPA entity name

Method Summary

Modifier and Type	Method and Description
Serializable	generate(SharedSessionContractImplementor session, Object object) Generate a new identifier.

Field Detail

ENTITY_NAME

static final String ENTITY_NAME

The configuration parameter holding the entity name

See Also:

Constant Field Values

JPA_ENTITY_NAME

static final String JPA_ENTITY_NAME

The configuration parameter holding the JPA entity name

See Also:

Constant Field Values

GENERATOR_NAME

static final String GENERATOR_NAME

Used as a key to pass the name used as GeneratedValue.generator() to the IdentifierGenerator as it is configured.

See Also:

Constant Field Values

Method Detail

generate

Serializable generate(SharedSessionContractImplementor session,
                      Object object)
               throws HibernateException

Generate a new identifier.

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