Package org.hibernate.id

Class CompositeNestedGeneratedValueGenerator

java.lang.Object

org.hibernate.id.CompositeNestedGeneratedValueGenerator

All Implemented Interfaces:

Serializable, ExportableProducer, BeforeExecutionGenerator, Generator, Configurable, IdentifierGenerator, IdentifierGeneratorAggregator

@Internal
public class CompositeNestedGeneratedValueGenerator
extends Object
implements IdentifierGenerator, IdentifierGeneratorAggregator, Serializable

For composite identifiers, defines a number of "nested" generations that need to happen to "fill" the identifier property(s).

This generator is used implicitly for all composite identifier scenarios if an explicit generator is not in place. So it make sense to discuss the various potential scenarios:

• "embedded" composite identifier - this is possible only in HBM mappings as <composite-id/> (notice the lack of both a name and class attribute declarations). The term "embedded" here refers to the Hibernate usage which is actually the exact opposite of the JPA meaning of "embedded". Essentially this means that the entity class itself holds the named composite pk properties. This is very similar to the JPA @IdClass usage, though without a separate pk-class for loading.
• pk-class as entity attribute - this is possible in both annotations (@EmbeddedId) and HBM mappings (<composite-id name="idAttributeName" class="PkClassName"/>)
• "embedded" composite identifier with a pk-class - this is the JPA @IdClass use case and is only possible in annotations

Most of the grunt work is done in Component.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompositeNestedGeneratedValueGenerator.GenerationContextLocator	Contract for declaring how to locate the context for sub-value injection.
static interface	CompositeNestedGeneratedValueGenerator.GenerationPlan	Contract for performing the actual sub-value generation, usually injecting it into the determined context

Field Summary

Fields inherited from interface org.hibernate.id.IdentifierGenerator

CONTRIBUTOR_NAME, ENTITY_NAME, GENERATOR_NAME, JPA_ENTITY_NAME

Constructor Summary

Constructors

Constructor	Description
CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator, CompositeType compositeType)
CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator, CompositeType compositeType, List<CompositeNestedGeneratedValueGenerator.GenerationPlan> generationPlans)

Method Summary

Modifier and Type	Method	Description
void	addGeneratedValuePlan(CompositeNestedGeneratedValueGenerator.GenerationPlan plan)
Object	generate(SharedSessionContractImplementor session, Object object)	Generate a new identifier.
CompositeType	getCompositeType()
CompositeNestedGeneratedValueGenerator.GenerationContextLocator	getGenerationContextLocator()
List<CompositeNestedGeneratedValueGenerator.GenerationPlan>	getGenerationPlans()
void	initialize(SqlStringGenerationContext context)	Initializes this instance, pre-generating SQL if necessary.
void	registerExportables(Database database)	Register database objects used by this identifier generator, for example, a sequence or tables.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.generator.BeforeExecutionGenerator

generatedOnExecution

Methods inherited from interface org.hibernate.id.Configurable

configure

Methods inherited from interface org.hibernate.generator.Generator

allowAssignedIdentifiers, allowMutation, generatedBeforeExecution, generatedOnExecution, generatesOnForceIncrement, generatesOnInsert, generatesOnUpdate, generatesSometimes

Methods inherited from interface org.hibernate.id.IdentifierGenerator

configure, generate, getEventTypes

Constructor Details

CompositeNestedGeneratedValueGenerator

public CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator,
 CompositeType compositeType)

CompositeNestedGeneratedValueGenerator

public CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator,
 CompositeType compositeType,
 List<CompositeNestedGeneratedValueGenerator.GenerationPlan> generationPlans)

Method Details

addGeneratedValuePlan

public void addGeneratedValuePlan(CompositeNestedGeneratedValueGenerator.GenerationPlan plan)

generate

public Object generate(SharedSessionContractImplementor session,
 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

registerExportables

public void registerExportables(Database database)

Description copied from interface: IdentifierGenerator

Register database objects used by this identifier generator, for example, a sequence or tables.

This method is called just once, after Configurable.configure(GeneratorCreationContext, Properties).

Specified by:

registerExportables in interface ExportableProducer

Specified by:

registerExportables in interface IdentifierGenerator

Parameters:

database - The database instance

initialize

public void initialize(SqlStringGenerationContext context)

Description copied from interface: Configurable

Initializes this instance, pre-generating SQL if necessary.

If this instance also implements ExportableProducer, then this method is always called after ExportableProducer.registerExportables(Database), and before first use.

Specified by:

initialize in interface Configurable

Parameters:

context - A context to help generate SQL strings

getGenerationPlans

public List<CompositeNestedGeneratedValueGenerator.GenerationPlan> getGenerationPlans()

getGenerationContextLocator

public CompositeNestedGeneratedValueGenerator.GenerationContextLocator getGenerationContextLocator()

getCompositeType

public CompositeType getCompositeType()