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 org.hibernate.mapping.Component.

Nested and Inner Type Summary

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

Modifier and Type	Field and Description
private final CompositeType	compositeType
private final CompositeNestedGeneratedValueGenerator.GenerationContextLocator	generationContextLocator
private final List<CompositeNestedGeneratedValueGenerator.GenerationPlan>	generationPlans

Constructor Summary

Access	Constructor and Description
public	CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator, CompositeType compositeType)

Method Summary

Modifier and Type	Method and Description
public void	addGeneratedValuePlan(CompositeNestedGeneratedValueGenerator.GenerationPlan plan)
public Object	generate(SharedSessionContractImplementor The session from which the request originates session, Object the entity or collection (idbag) for which the id is being generated object) Implements org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier.
public void	initialize(SqlStringGenerationContext A context to help generate SQL strings context) Overrides default org.hibernate.id.IdentifierGenerator.initialize. Initializes this instance, in particular pre-generates SQL as necessary.
public void	registerExportables(Database The database instance database) Overrides default org.hibernate.id.IdentifierGenerator.registerExportables. Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables. Register database objects used by this identifier generator, for example, a sequence or tables.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

compositeType	back to summary
private final CompositeType compositeType

generationContextLocator	back to summary
private final CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator

generationPlans	back to summary
private final List<CompositeNestedGeneratedValueGenerator.GenerationPlan> generationPlans

Constructor Detail

CompositeNestedGeneratedValueGenerator	back to summary
public CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator, CompositeType compositeType)

Method Detail

addGeneratedValuePlan	back to summary
public void addGeneratedValuePlan(CompositeNestedGeneratedValueGenerator.GenerationPlan plan)

generate	back to summary
public Object generate(SharedSessionContractImplementor session, Object object) throws HibernateException Implements org.hibernate.id.IdentifierGenerator.generate. Doc from org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier. Parameters session:SharedSessionContractImplementor The session from which the request originates object:Object the entity or collection (idbag) for which the id is being generated Returns:Object a new identifier Annotations @Override Exceptions HibernateException: Indicates trouble generating the identifier

generate

back to summary

public Object generate(SharedSessionContractImplementor session, Object object) throws HibernateException

Implements org.hibernate.id.IdentifierGenerator.generate.

Doc from org.hibernate.id.IdentifierGenerator.generate.

Generate a new identifier.

Parameters

session:SharedSessionContractImplementor: The session from which the request originates
object:Object: the entity or collection (idbag) for which the id is being generated

Returns:Object

a new identifier

Annotations

@Override

Exceptions

HibernateException:: Indicates trouble generating the identifier

initialize back to summary

initialize	back to summary
public void initialize(SqlStringGenerationContext context) Overrides default org.hibernate.id.IdentifierGenerator.initialize. Doc from org.hibernate.id.IdentifierGenerator.initialize. Initializes this instance, in particular pre-generates SQL as necessary. This method is called after `registerExportables(Database)`, and before first use. Parameters context:SqlStringGenerationContext A context to help generate SQL strings Annotations @Override

public void initialize(SqlStringGenerationContext context)

Overrides default org.hibernate.id.IdentifierGenerator.initialize.

Doc from org.hibernate.id.IdentifierGenerator.initialize.

Initializes this instance, in particular pre-generates SQL as necessary.

This method is called after registerExportables(Database), and before first use.

Parameters

context:SqlStringGenerationContext: A context to help generate SQL strings

Annotations

@Override

registerExportables back to summary

registerExportables	back to summary
public void registerExportables(Database database) Overrides default org.hibernate.id.IdentifierGenerator.registerExportables. Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables. Doc from org.hibernate.id.IdentifierGenerator.registerExportables. Register database objects used by this identifier generator, for example, a sequence or tables. This method is called just once, after `configure(Type, Properties, ServiceRegistry)`. Parameters database:Database The database instance Annotations @Override

public void registerExportables(Database database)

Overrides default org.hibernate.id.IdentifierGenerator.registerExportables.

Implements org.hibernate.boot.model.relational.ExportableProducer.registerExportables.

Doc from org.hibernate.id.IdentifierGenerator.registerExportables.

This method is called just once, after configure(Type, Properties, ServiceRegistry).

Parameters

database:Database: The database instance

Annotations

@Override

org.hibernate.id back to summary

public Interface CompositeNestedGeneratedValueGenerator.GenerationContextLocator

Known Direct Implementers: org.hibernate.mapping.Component.StandardGenerationContextLocator

Contract for declaring how to locate the context for sub-value injection.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: The injection context locateGenerationContext(SharedSessionContractImplementor The current session session, Object The entity for which we are generating id incomingObject) Given the incoming object, determine the context for injecting back its generated id sub-values.

Method Detail

locateGenerationContext	back to summary
public Object locateGenerationContext(SharedSessionContractImplementor session, Object incomingObject) Given the incoming object, determine the context for injecting back its generated id sub-values. Parameters session:SharedSessionContractImplementor The current session incomingObject:Object The entity for which we are generating id Returns:Object The injection context

locateGenerationContext

back to summary

public Object locateGenerationContext(SharedSessionContractImplementor session, Object incomingObject)

Given the incoming object, determine the context for injecting back its generated id sub-values.

Parameters

session:SharedSessionContractImplementor: The current session
incomingObject:Object: The entity for which we are generating id

Returns:Object

The injection context

org.hibernate.id back to summary

public Interface CompositeNestedGeneratedValueGenerator.GenerationPlan

Known Direct Implementers: org.hibernate.mapping.Component.ValueGenerationPlan

Contract for performing the actual sub-value generation, usually injecting it into the determined context

Method Summary

Modifier and Type	Method and Description
public Object	execute(SharedSessionContractImplementor The current session session, Object The entity for which we are generating id incomingObject) Execute the value generation.
public Setter	getInjector() Returns the `injector` for the generated property.
public int	getPropertyIndex() Returns the index of the generated property.
public void	initialize(SqlStringGenerationContext A context to help generate SQL strings context) Initializes this instance, in particular pre-generates SQL as necessary.

Inherited from org.hibernate.boot.model.relational.ExportableProducer:: registerExportables

Method Detail

execute	back to summary
public Object execute(SharedSessionContractImplementor session, Object incomingObject) Execute the value generation. Parameters session:SharedSessionContractImplementor The current session incomingObject:Object The entity for which we are generating id

execute

back to summary

public Object execute(SharedSessionContractImplementor session, Object incomingObject)

Execute the value generation.

Parameters

session:SharedSessionContractImplementor: The current session
incomingObject:Object: The entity for which we are generating id

getInjector back to summary

getInjector	back to summary
public Setter getInjector() Returns the `injector` for the generated property. Used when the `CompositeType` is mutable. See Also `getPropertyIndex()`

public Setter getInjector()

Returns the injector for the generated property. Used when the CompositeType is mutable.

See Also: getPropertyIndex()

getPropertyIndex back to summary

getPropertyIndex	back to summary
public int getPropertyIndex() Returns the index of the generated property. Used when the `CompositeType` is not mutable. See Also `getInjector()`

public int getPropertyIndex()

Returns the index of the generated property. Used when the CompositeType is not mutable.

See Also: getInjector()

initialize back to summary

initialize	back to summary
public void initialize(SqlStringGenerationContext context) Initializes this instance, in particular pre-generates SQL as necessary. This method is called after `registerExportables(Database)`, before first use. Parameters context:SqlStringGenerationContext A context to help generate SQL strings

public void initialize(SqlStringGenerationContext context)

Initializes this instance, in particular pre-generates SQL as necessary.

This method is called after registerExportables(Database), before first use.

Parameters

context:SqlStringGenerationContext: A context to help generate SQL strings

public Class CompositeNestedGeneratedValueGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface CompositeNestedGeneratedValueGenerator.GenerationContextLocator

Method Summary

Method Detail

public Interface CompositeNestedGeneratedValueGenerator.GenerationPlan

Method Summary

Method Detail