Package org.hibernate.metamodel.mapping.internal

Class AbstractDiscriminatorMapping

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractDiscriminatorMapping

All Implemented Interfaces:

BasicValuedMapping, BasicValuedModelPart, Bindable, DiscriminatorMapping, EntityDiscriminatorMapping, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMapping, SelectableMappings, SqlExpressible, SqlTypedMapping, ValuedModelPart, ValueMapping, VirtualModelPart, Fetchable, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible

Direct Known Subclasses:

CaseStatementDiscriminatorMappingImpl, ExplicitColumnDiscriminatorMappingImpl

public abstract class AbstractDiscriminatorMapping
extends Object
implements EntityDiscriminatorMapping

Implementation Note:

`discriminatorType` represents the mapping to Class, whereas `discriminatorType.getUnderlyingType()` represents the "raw" JDBC mapping (String, Integer, etc)

Nested Class Summary

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.ModelPart

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

Field Summary

Fields inherited from interface org.hibernate.metamodel.mapping.EntityDiscriminatorMapping

LEGACY_HQL_ROLE_NAME, ROLE_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractDiscriminatorMapping(EntityMappingType entityDescriptor, DiscriminatorType<Object> discriminatorType, BasicType<Object> underlyingJdbcMapping)

Method Summary

Modifier and Type	Method	Description
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
<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.
DomainResult	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
Object	disassemble(Object value, SharedSessionContractImplementor session)
EntityMappingType	findContainingEntityMapping()
<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
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
BasicFetch<?>	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
EntityMappingType	getEntityDescriptor()
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
MappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
BasicType<?>	getUnderlyingJdbcMapping()
DiscriminatorConverter<?,?>	getValueConverter()	Information about the value mappings
DiscriminatorValueDetails	resolveDiscriminatorValue(Object value)	Retrieve the details for a particular discriminator value.

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.BasicValuedMapping

addToCacheKey

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

forEachSelectable, getJdbcMapping, getJdbcMappings, getJdbcTypeCount, getPartMappingType, getSelectable, getSingleJdbcMapping, hasPartitionedSelectionMapping

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

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

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

getDomainJavaType, getRelationalJavaType

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

getFetchableKey, getFetchableName, getMappedFetchOptions, getPartName, getStyle, getTiming, hasPhysicalColumn, resolveSqlExpression

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

asAttributeMapping, incrementFetchDepth, isSelectable, resolveCircularFetch

Methods inherited from interface org.hibernate.type.descriptor.java.JavaTypedExpressible

addToCacheKey

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

areEqual, asEntityMappingType, breakDownJdbcValues, decompose, decompose, isEntityIdentifierMapping

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

getContainingTableExpression, getCustomReadExpression, getCustomWriteExpression, getSelectableName, getSelectablePath, getSelectionExpression, getWriteExpression, isFormula, isInsertable, isNullable, isPartitioned, isUpdateable

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

getColumnDefinition, getLength, getPrecision, getScale, isLob

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

forEachInsertable, forEachNonFormula, forEachUpdatable, getContainingTableExpression

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

getExpressibleJavaType, treatAs

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

isVirtual

Constructor Detail

AbstractDiscriminatorMapping

public AbstractDiscriminatorMapping(EntityMappingType entityDescriptor,
                                    DiscriminatorType<Object> discriminatorType,
                                    BasicType<Object> underlyingJdbcMapping)

Method Detail

getEntityDescriptor

public EntityMappingType getEntityDescriptor()

getUnderlyingJdbcMapping

public BasicType<?> getUnderlyingJdbcMapping()

Specified by:

getUnderlyingJdbcMapping in interface DiscriminatorMapping

getValueConverter

public DiscriminatorConverter<?,?> getValueConverter()

Description copied from interface: DiscriminatorMapping

Information about the value mappings

Specified by:

getValueConverter in interface DiscriminatorMapping

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

ModelPart.getPartName()

getJdbcMapping

public JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface SqlExpressible

Specified by:

getJdbcMapping in interface SqlTypedMapping

resolveDiscriminatorValue

public DiscriminatorValueDetails resolveDiscriminatorValue(Object value)

Description copied from interface: EntityDiscriminatorMapping

Retrieve the details for a particular discriminator value. Returns null if there is no match.

Specified by:

resolveDiscriminatorValue in interface EntityDiscriminatorMapping

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

getJavaType

public JavaType<?> getJavaType()

Description copied from interface: ModelPart

The Java type for this part. Generally equivalent to MappingType.getMappedJavaType() relative to ModelPart.getPartMappingType()

Specified by:

getJavaType in interface ModelPart

createDomainResult

public DomainResult createDomainResult(NavigablePath navigablePath,
                                       TableGroup tableGroup,
                                       String resultVariable,
                                       DomainResultCreationState creationState)

Description copied from interface: ModelPart

Create a DomainResult for a specific reference to this ModelPart.

Specified by:

createDomainResult in interface ModelPart

generateFetch

public BasicFetch<?> generateFetch(FetchParent fetchParent,
                                   NavigablePath fetchablePath,
                                   FetchTiming fetchTiming,
                                   boolean selected,
                                   String resultVariable,
                                   DomainResultCreationState creationState)

Description copied from interface: Fetchable

Generates a Fetch of this fetchable

Specified by:

generateFetch in interface EntityDiscriminatorMapping

Specified by:

generateFetch in interface Fetchable

Parameters:

fetchParent - The parent of the Fetch we are generating

fetchablePath - The overall path within the graph

fetchTiming - The requested fetch timing

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
                               TableGroup tableGroup,
                               DomainResultCreationState creationState)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
                               TableGroup tableGroup,
                               DomainResultCreationState creationState,
                               BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

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

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 JdbcMappingContainer

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)

Specified by:

disassemble in interface BasicValuedMapping

Specified by:

disassemble in interface Bindable

See Also:

As an example, consider the following domain model: ````

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 BasicValuedModelPart

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

SelectableConsumer.accept(int, SelectableMapping)