Package org.hibernate.metamodel.mapping.internal

Class AbstractEmbeddableMapping

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractEmbeddableMapping

All Implemented Interfaces:

Bindable, EmbeddableMappingType, EmbeddableMappingType.ConcreteEmbeddableType, JdbcMappingContainer, ManagedMappingType, MappingModelExpressible, MappingType, ModelPart, ModelPartContainer, SelectableMappings, FetchableContainer

Direct Known Subclasses:

EmbeddableMappingTypeImpl, IdClassEmbeddable, VirtualIdEmbeddable

public abstract class AbstractEmbeddableMapping
extends Object
implements EmbeddableMappingType, EmbeddableMappingType.ConcreteEmbeddableType

Base support for EmbeddableMappingType implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractEmbeddableMapping.AttributeTypeValidator
protected static interface	AbstractEmbeddableMapping.ConcreteTableResolver
protected static class	AbstractEmbeddableMapping.IllegalAttributeType
protected static interface	AbstractEmbeddableMapping.SuccessfulCompletionCallback

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.EmbeddableMappingType

EmbeddableMappingType.ConcreteEmbeddableType

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.ModelPart

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields

Modifier and Type	Field	Description
protected MutableAttributeMappingList	attributeMappings
protected Getter[]	getterCache
protected SelectableMappings	selectableMappings
protected Setter[]	setterCache

Constructor Summary

Constructors

Constructor	Description
AbstractEmbeddableMapping(MutableAttributeMappingList attributeMappings)

Method Summary

Modifier and Type	Method	Description
protected void	addAttribute(AttributeMapping attributeMapping)
void	addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)	Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
<X,Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Breaks down the domain value to its constituent JDBC values.
protected void	buildGetterSetterCache()
boolean	declaresAttribute(int attributeIndex)
boolean	declaresAttribute(AttributeMapping attributeMapping)	Returns true if the provided embeddable class contains the specified attribute mapping, false otherwise.
protected String	determineEmbeddablePrefix()
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
AttributeMapping	findAttributeMapping(String name)	Find an attribute by name.
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)
protected boolean	finishInitialization(NavigableRole navigableRole, Component bootDescriptor, CompositeType compositeType, String rootTableExpression, String[] rootTableKeyColumnNames, EmbeddableMappingType declarer, EmbeddableRepresentationStrategy representationStrategy, AbstractEmbeddableMapping.AttributeTypeValidator attributeTypeValidator, AbstractEmbeddableMapping.ConcreteTableResolver concreteTableResolver, Consumer<AttributeMapping> attributeConsumer, AbstractEmbeddableMapping.SuccessfulCompletionCallback completionCallback, MappingModelCreationProcess creationProcess)
void	forEachAttributeMapping(Consumer<? super AttributeMapping> action)	Visit attributes defined on this class and any supers
void	forEachAttributeMapping(IndexedConsumer<? super AttributeMapping> consumer)	Visit attributes defined on this class and any supers
<X,Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
<X,Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Visit each constituent JDBC value extracted from the entity instance itself.
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
int	forEachSelectable(SelectableConsumer consumer)	A short hand form of ModelPart.forEachSelectable(int, SelectableConsumer), that passes 0 as offset.
void	forEachSubPart(IndexedConsumer<ModelPart> consumer, EntityMappingType treatTarget)
AttributeMapping	getAttributeMapping(int position)	Retrieve an attribute by its contributor position
AttributeMappingsList	getAttributeMappings()	Get access to the attributes defined on this class and any supers
protected Object[]	getAttributeValues(Object compositeInstance)
Collection<EmbeddableMappingType.ConcreteEmbeddableType>	getConcreteEmbeddableTypes()	Returns the concrete embeddable subtypes or an empty collection if EmbeddableMappingType.isPolymorphic() is false.
Object	getDiscriminatorValue()
Fetchable	getFetchable(int position)
EmbeddableInstantiator	getInstantiator()
JdbcMapping	getJdbcMapping(int index)
int	getJdbcTypeCount()	The number of JDBC mappings
JavaType<?>	getMappedJavaType()	The descriptor descriptor for the mapped Java type
int	getNumberOfAttributeMappings()	Get the number of attributes defined on this class and any supers
int	getNumberOfFetchables()	The number of fetchables in the container
SelectableMapping	getSelectable(int columnIndex)	Get the selectable at the given position
protected SelectableMappings	getSelectableMappings()
int	getSubclassId()
Object	getValue(Object instance, int position)	Extract a specific attribute value from the entity instance, by position
Object[]	getValues(Object compositeInstance)	Extract the individual attribute values from the entity instance
protected boolean	initColumnMappings()
protected boolean	inverseInitializeCallback(TableGroupProducer declaringTableGroupProducer, SelectableMappings selectableMappings, EmbeddableMappingType inverseMappingType, MappingModelCreationProcess creationProcess, ManagedMappingType declaringType, MutableAttributeMappingList mappings)
protected void	setAttributeValues(Object component, Object[] values)
void	setValue(Object instance, int position, Object value)	Inject a specific attribute value into the entity instance, by position
void	setValues(Object component, Object[] values)	Inject the attribute values into the entity instance
void	visitFetchables(Consumer<? super Fetchable> consumer, EntityMappingType treatTargetType)
void	visitFetchables(IndexedConsumer<? super Fetchable> indexedConsumer, EntityMappingType treatTargetType)
void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType treatTargetType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface org.hibernate.metamodel.mapping.EmbeddableMappingType

anyRequiresAggregateColumnWriter, applySqlSelections, applySqlSelections, compare, createDomainResult, createInverseMappingType, findSubtypeByDiscriminator, findSubtypeBySubclass, forEachInsertable, forEachUpdatable, getAggregateMapping, getDiscriminatorMapping, getEmbeddedValueMapping, getJdbcValueCount, getJdbcValueSelectable, getPartMappingType, getRepresentationStrategy, getSelectableIndex, isCreateEmptyCompositesEnabled, isPolymorphic, requiresAggregateColumnWriter, shouldBindAggregateMapping, shouldMutateAggregateMapping, shouldSelectAggregateMapping

Methods inherited from interface org.hibernate.sql.results.graph.FetchableContainer

getKeyFetchable, getNumberOfFetchableKeys, getNumberOfKeyFetchables, visitFetchables, visitKeyFetchables, visitKeyFetchables, visitKeyFetchables

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMappingContainer

getSingleJdbcMapping

Methods inherited from interface org.hibernate.metamodel.mapping.ManagedMappingType

getJavaType, hasPartitionedSelectionMapping, isAffectedByEnabledFilters

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPart

areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, decompose, decompose, findContainingEntityMapping, getNavigableRole, getPartName, isEntityIdentifierMapping, isVirtual

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPartContainer

findByPath, findByPath, forEachSubPart

Field Detail

attributeMappings

protected final MutableAttributeMappingList attributeMappings

selectableMappings

protected SelectableMappings selectableMappings

getterCache

protected Getter[] getterCache

setterCache

protected Setter[] setterCache

Constructor Detail

AbstractEmbeddableMapping

public AbstractEmbeddableMapping(MutableAttributeMappingList attributeMappings)

Method Detail

getInstantiator

public EmbeddableInstantiator getInstantiator()

Specified by:

getInstantiator in interface EmbeddableMappingType.ConcreteEmbeddableType

getSubclassId

public int getSubclassId()

Specified by:

getSubclassId in interface EmbeddableMappingType.ConcreteEmbeddableType

getConcreteEmbeddableTypes

public Collection<EmbeddableMappingType.ConcreteEmbeddableType> getConcreteEmbeddableTypes()

Description copied from interface: EmbeddableMappingType

Returns the concrete embeddable subtypes or an empty collection if EmbeddableMappingType.isPolymorphic() is false.

Specified by:

getConcreteEmbeddableTypes in interface EmbeddableMappingType

declaresAttribute

public boolean declaresAttribute(AttributeMapping attributeMapping)

Description copied from interface: EmbeddableMappingType.ConcreteEmbeddableType

Returns true if the provided embeddable class contains the specified attribute mapping, false otherwise.

Specified by:

declaresAttribute in interface EmbeddableMappingType.ConcreteEmbeddableType

Parameters:

attributeMapping - the attribute to check

declaresAttribute

public boolean declaresAttribute(int attributeIndex)

Specified by:

declaresAttribute in interface EmbeddableMappingType.ConcreteEmbeddableType

getValue

public Object getValue(Object instance,
                       int position)

Description copied from interface: ManagedMappingType

Extract a specific attribute value from the entity instance, by position

Specified by:

getValue in interface ManagedMappingType

setValue

public void setValue(Object instance,
                     int position,
                     Object value)

Description copied from interface: ManagedMappingType

Inject a specific attribute value into the entity instance, by position

Specified by:

setValue in interface ManagedMappingType

getDiscriminatorValue

public Object getDiscriminatorValue()

Specified by:

getDiscriminatorValue in interface EmbeddableMappingType.ConcreteEmbeddableType

getMappedJavaType

public JavaType<?> getMappedJavaType()

Description copied from interface: MappingType

The descriptor descriptor for the mapped Java type

Specified by:

getMappedJavaType in interface MappingType

getValues

public Object[] getValues(Object compositeInstance)

Description copied from interface: ManagedMappingType

Extract the individual attribute values from the entity instance

Specified by:

getValues in interface ManagedMappingType

getAttributeValues

protected Object[] getAttributeValues(Object compositeInstance)

setValues

public void setValues(Object component,
                      Object[] values)

Description copied from interface: ManagedMappingType

Inject the attribute values into the entity instance

Specified by:

setValues in interface ManagedMappingType

setAttributeValues

protected void setAttributeValues(Object component,
                                  Object[] values)

inverseInitializeCallback

protected boolean inverseInitializeCallback(TableGroupProducer declaringTableGroupProducer,
                                            SelectableMappings selectableMappings,
                                            EmbeddableMappingType inverseMappingType,
                                            MappingModelCreationProcess creationProcess,
                                            ManagedMappingType declaringType,
                                            MutableAttributeMappingList mappings)

finishInitialization

protected boolean finishInitialization(NavigableRole navigableRole,
                                       Component bootDescriptor,
                                       CompositeType compositeType,
                                       String rootTableExpression,
                                       String[] rootTableKeyColumnNames,
                                       EmbeddableMappingType declarer,
                                       EmbeddableRepresentationStrategy representationStrategy,
                                       AbstractEmbeddableMapping.AttributeTypeValidator attributeTypeValidator,
                                       AbstractEmbeddableMapping.ConcreteTableResolver concreteTableResolver,
                                       Consumer<AttributeMapping> attributeConsumer,
                                       AbstractEmbeddableMapping.SuccessfulCompletionCallback completionCallback,
                                       MappingModelCreationProcess creationProcess)

determineEmbeddablePrefix

protected String determineEmbeddablePrefix()

getNumberOfFetchables

public int getNumberOfFetchables()

Description copied from interface: FetchableContainer

The number of fetchables in the container

Specified by:

getNumberOfFetchables in interface FetchableContainer

getFetchable

public Fetchable getFetchable(int position)

Specified by:

getFetchable in interface FetchableContainer

visitFetchables

public void visitFetchables(Consumer<? super Fetchable> consumer,
                            EntityMappingType treatTargetType)

Specified by:

visitFetchables in interface FetchableContainer

visitFetchables

public void visitFetchables(IndexedConsumer<? super Fetchable> indexedConsumer,
                            EntityMappingType treatTargetType)

Specified by:

visitFetchables in interface FetchableContainer

getNumberOfAttributeMappings

public int getNumberOfAttributeMappings()

Description copied from interface: ManagedMappingType

Get the number of attributes defined on this class and any supers

Specified by:

getNumberOfAttributeMappings in interface ManagedMappingType

getAttributeMapping

public AttributeMapping getAttributeMapping(int position)

Description copied from interface: ManagedMappingType

Retrieve an attribute by its contributor position

Specified by:

getAttributeMapping in interface ManagedMappingType

findAttributeMapping

public AttributeMapping findAttributeMapping(String name)

Description copied from interface: ManagedMappingType

Find an attribute by name.

Specified by:

findAttributeMapping in interface ManagedMappingType

Returns:

The named attribute, or null if no match was found

getAttributeMappings

public AttributeMappingsList getAttributeMappings()

Description copied from interface: ManagedMappingType

Get access to the attributes defined on this class and any supers

Specified by:

getAttributeMappings in interface ManagedMappingType

getSelectable

public SelectableMapping getSelectable(int columnIndex)

Description copied from interface: SelectableMappings

Get the selectable at the given position

Specified by:

getSelectable in interface SelectableMappings

forEachSelectable

public int forEachSelectable(SelectableConsumer consumer)

Description copied from interface: ModelPart

A short hand form of ModelPart.forEachSelectable(int, SelectableConsumer), that passes 0 as offset.

Specified by:

forEachSelectable in interface EmbeddableMappingType

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Description copied from interface: ModelPart

Visits each selectable mapping with the selectable index offset by the given value. Returns the amount of jdbc types that have been visited.

Specified by:

forEachSelectable in interface EmbeddableMappingType

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

See Also:

SelectableConsumer.accept(int, SelectableMapping)

getJdbcTypeCount

public int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface EmbeddableMappingType

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

Specified by:

getJdbcTypeCount in interface SelectableMappings

forEachJdbcType

public int forEachJdbcType(int offset,
                           IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface EmbeddableMappingType

Specified by:

forEachJdbcType in interface JdbcMappingContainer

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer

forEachAttributeMapping

public void forEachAttributeMapping(IndexedConsumer<? super AttributeMapping> consumer)

Description copied from interface: ManagedMappingType

Visit attributes defined on this class and any supers

Specified by:

forEachAttributeMapping in interface ManagedMappingType

forEachAttributeMapping

public void forEachAttributeMapping(Consumer<? super AttributeMapping> action)

Description copied from interface: ManagedMappingType

Visit attributes defined on this class and any supers

Specified by:

forEachAttributeMapping in interface ManagedMappingType

findSubPart

public ModelPart findSubPart(String name,
                             EntityMappingType treatTargetType)

Specified by:

findSubPart in interface ModelPartContainer

forEachSubPart

public void forEachSubPart(IndexedConsumer<ModelPart> consumer,
                           EntityMappingType treatTarget)

Specified by:

forEachSubPart in interface ModelPartContainer

visitSubParts

public void visitSubParts(Consumer<ModelPart> consumer,
                          EntityMappingType treatTargetType)

Specified by:

visitSubParts in interface ModelPartContainer

breakDownJdbcValues

public <X,Y> int breakDownJdbcValues(Object domainValue,
                                           int offset,
                                           X x,
                                           Y y,
                                           ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
                                           SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Breaks down the domain value to its constituent JDBC values. Think of it as breaking the multi-dimensional array into a visitable flat array. Additionally, it passes through the values X and Y to the consumer. Returns the amount of jdbc types that have been visited.

Specified by:

breakDownJdbcValues in interface ModelPart

disassemble

public Object disassemble(Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

 @Entity class Person {
     @Id Integer id;
     @Embedded Name name;
     int age;
 }

 @Embeddable class Name {
     String familiarName;
     String familyName;
 }
 

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

 Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
 

this disassemble would result in a multidimensional array:

 [ ["Steve", "Ebersole"], 28 ]
 

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface Bindable

See Also:

EntityEntry

addToCacheKey

public void addToCacheKey(MutableCacheKeyBuilder cacheKey,
                          Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.

Specified by:

addToCacheKey in interface Bindable

Parameters:

cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode

value - the value to disassemble

session - the SharedSessionContractImplementor

forEachDisassembledJdbcValue

public <X,Y> int forEachDisassembledJdbcValue(Object value,
                                                    int offset,
                                                    X x,
                                                    Y y,
                                                    Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
                                                    SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

forEachJdbcValue

public <X,Y> int forEachJdbcValue(Object value,
                                        int offset,
                                        X x,
                                        Y y,
                                        Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
                                        SharedSessionContractImplementor session)

Description copied from interface: Bindable

Visit each constituent JDBC value extracted from the entity instance itself. Short-hand form of calling Bindable.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) and piping its result to Bindable.forEachDisassembledJdbcValue(Object, int, JdbcValuesConsumer, SharedSessionContractImplementor)

Specified by:

forEachJdbcValue in interface Bindable

addAttribute

protected void addAttribute(AttributeMapping attributeMapping)

getSelectableMappings

protected SelectableMappings getSelectableMappings()

initColumnMappings

protected boolean initColumnMappings()

buildGetterSetterCache

protected void buildGetterSetterCache()