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 CompositeNestedGeneratedValueGenerator.GenerationContextLocator	generationContextLocator
private List<E>	generationPlans

Constructor Summary

Access	Constructor and Description
public	CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator)

Method Summary

Modifier and Type	Method and Description
public void	addGeneratedValuePlan(CompositeNestedGeneratedValueGenerator.GenerationPlan plan)
public Serializable	generate(SessionImplementor session, Object the entity or toplevel collection for which the id is being generated object) Implements org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier.
public void	registerPersistentGenerators(Map<K, V> The map of generators. generatorMap) Implements org.hibernate.id.IdentifierGeneratorAggregator.registerPersistentGenerators. Register any sub generators which implement `PersistentIdentifierGenerator` by their `generatorKey`.

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

generationContextLocator	back to summary
private final CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator

generationPlans	back to summary
private List<E> generationPlans

Constructor Detail

CompositeNestedGeneratedValueGenerator	back to summary
public CompositeNestedGeneratedValueGenerator(CompositeNestedGeneratedValueGenerator.GenerationContextLocator generationContextLocator)

Method Detail

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

generate	back to summary
public Serializable generate(SessionImplementor session, Object object) throws HibernateException Implements org.hibernate.id.IdentifierGenerator.generate. Doc from org.hibernate.id.IdentifierGenerator.generate. Generate a new identifier. Parameters object:Object the entity or toplevel collection for which the id is being generated Returns:Serializable a new identifier

generate

back to summary

public Serializable generate(SessionImplementor session, Object object) throws HibernateException

Implements org.hibernate.id.IdentifierGenerator.generate.

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

Generate a new identifier.

Parameters

object:Object: the entity or toplevel collection for which the id is being generated

Returns:Serializable

a new identifier

registerPersistentGenerators back to summary

registerPersistentGenerators	back to summary
public void registerPersistentGenerators(Map<K, V> generatorMap) Implements org.hibernate.id.IdentifierGeneratorAggregator.registerPersistentGenerators. Doc from org.hibernate.id.IdentifierGeneratorAggregator.registerPersistentGenerators. Register any sub generators which implement `PersistentIdentifierGenerator` by their `generatorKey`. Parameters generatorMap:Map<K, V> The map of generators.

public void registerPersistentGenerators(Map<K, V> generatorMap)

Implements org.hibernate.id.IdentifierGeneratorAggregator.registerPersistentGenerators.

Doc from org.hibernate.id.IdentifierGeneratorAggregator.registerPersistentGenerators.

Parameters

generatorMap:Map<K, V>: The map of generators.

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 Serializable	Returns: The injection context locateGenerationContext(SessionImplementor 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 Serializable locateGenerationContext(SessionImplementor session, Object incomingObject) Given the incoming object, determine the context for injecting back its generated id sub-values. Parameters session:SessionImplementor The current session incomingObject:Object The entity for which we are generating id Returns:Serializable The injection context

locateGenerationContext

back to summary

public Serializable locateGenerationContext(SessionImplementor session, Object incomingObject)

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

Parameters

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

Returns:Serializable

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 void	execute(SessionImplementor The current session session, Object The entity for which we are generating id incomingObject, Object The context into which the generated value can be injected injectionContext) Execute the value generation.
public void	registerPersistentGenerators(Map<K, V> The map of generators. generatorMap) Register any sub generators which implement `PersistentIdentifierGenerator` by their `generatorKey`.

Method Detail

execute	back to summary
public void execute(SessionImplementor session, Object incomingObject, Object injectionContext) Execute the value generation. Parameters session:SessionImplementor The current session incomingObject:Object The entity for which we are generating id injectionContext:Object The context into which the generated value can be injected

execute

back to summary

public void execute(SessionImplementor session, Object incomingObject, Object injectionContext)

Execute the value generation.

Parameters

session:SessionImplementor: The current session
incomingObject:Object: The entity for which we are generating id
injectionContext:Object: The context into which the generated value can be injected

registerPersistentGenerators back to summary

registerPersistentGenerators	back to summary
public void registerPersistentGenerators(Map<K, V> generatorMap) Register any sub generators which implement `PersistentIdentifierGenerator` by their `generatorKey`. Parameters generatorMap:Map<K, V> The map of generators.

public void registerPersistentGenerators(Map<K, V> generatorMap)

Parameters

generatorMap:Map<K, V>: The map of generators.

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