Package org.hibernate.id

package org.hibernate.id

This package and its subpackages, especially org.hibernate.id.enhanced, contain the built-in id generators, all of which implement either IdentifierGenerator or PostInsertIdentifierGenerator.

The most useful id generators in modern Hibernate are:

• IdentityGenerator - @GeneratedValue(strategy=IDENTITY)
• SequenceStyleGenerator - @GeneratedValue(strategy=SEQUENCE)
• TableGenerator - @GeneratedValue(strategy=TABLE)
• UuidGenerator - @UuidGenerator

See Also:

• org.hibernate.generator

API Note:

The remaining id generators are kept around for backward compatibility and as an implementation detail of the hbm.xml mapping format.

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.id.enhanced	Enhanced/improved versions of table and sequence based identifier generators targeting portability and unified configuration.
org.hibernate.id.factory	Defines a service for creating id generators.
org.hibernate.id.insert	Contains a framework of strategies for retrieving database-generated ids.
org.hibernate.id.uuid	Contains the UuidGenerator.

Class	Description
AbstractPostInsertGenerator	Deprecated, for removal: This API element is subject to removal in a future version. Subclasses should now directly inherit PostInsertIdentifierGenerator and BulkInsertionCapableIdentifierGenerator, or even better, simply implement OnExecutionGenerator directly.
AbstractUUIDGenerator	Deprecated. since UUIDHexGenerator is deprecated
Assigned	An IdentifierGenerator that returns the current identifier assigned to an instance.
BulkInsertionCapableIdentifierGenerator	Specialized contract for IdentifierGenerator implementations capable of being used in conjunction with HQL insert statements.
CompositeNestedGeneratedValueGenerator	For composite identifiers, defines a number of "nested" generations that need to happen to "fill" the identifier property(s).
CompositeNestedGeneratedValueGenerator.GenerationContextLocator	Contract for declaring how to locate the context for sub-value injection.
CompositeNestedGeneratedValueGenerator.GenerationPlan	Contract for performing the actual sub-value generation, usually injecting it into the determined context
Configurable	A Generator that supports "configuration".
EntityIdentifierNature	Describes the possible natures of an entity-defined identifier.
ExportableColumn
ExportableColumn.ValueImpl
ForeignGenerator	Deprecated, for removal: This API element is subject to removal in a future version. This remains around as an implementation detail of hbm.xml mappings.
GUIDGenerator	Deprecated. use UuidGenerator
IdentifierGenerationException	Thrown by an IdentifierGenerator implementation class when ID generation fails.
IdentifierGenerator	A classic extension point from the very earliest days of Hibernate, this interface is no longer the only way to generate identifiers.
IdentifierGeneratorAggregator	Identifies generators which potentially aggregate other PersistentIdentifierGenerator generators.
IdentifierGeneratorHelper	Factory and helper methods for IdentifierGenerator framework.
IdentifierGeneratorHelper.BasicHolder
IdentifierGeneratorHelper.BigDecimalHolder
IdentifierGeneratorHelper.BigIntegerHolder
IdentityGenerator	An OnExecutionGenerator that handles IDENTITY/"autoincrement" columns on those databases which support them.
IncrementGenerator	An IdentifierGenerator that returns a long, constructed by counting from the maximum primary key value obtained by querying the table or tables at startup.
IntegralDataTypeHolder	Defines a common API for dealing with data of integral data type.
OptimizableGenerator	Commonality between sequence-based and table-based generators
PersistentIdentifierGenerator	An IdentifierGenerator that requires creation of database objects.
PostInsertIdentifierGenerator	The counterpart to IdentifierGenerator for values generated by the database.
PostInsertIdentityPersister	Deprecated, for removal: This API element is subject to removal in a future version. Use EntityPersister instead.
ResultSetIdentifierConsumer	Deprecated, for removal: This API element is subject to removal in a future version. this interface is unnecessary and no longer used
SelectGenerator	A generator that selects the just-inserted row to determine the column value assigned by the database.
SequenceMismatchStrategy	Describes the strategy for handling the mismatch between a database sequence configuration and the one defined by the entity mapping.
UUIDGenerationStrategy	Deprecated. see UUIDGenerator
UUIDGenerator	Deprecated. use UuidGenerator and UuidGenerator instead
UUIDHexGenerator	Deprecated. This remains around as an implementation detail of hbm.xml mappings.