Interface DiscriminatorMapping

All Superinterfaces:

BasicValuedMapping, BasicValuedModelPart, Bindable, Fetchable, JavaTypedExpressible, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMapping, SelectableMappings, SqlExpressible, SqlTypedMapping, ValuedModelPart, ValueMapping, VirtualModelPart

All Known Subinterfaces:

EmbeddableDiscriminatorMapping, EntityDiscriminatorMapping

public interface DiscriminatorMapping
extends VirtualModelPart, BasicValuedModelPart, Fetchable

Mapping of a discriminator, for either entity or association (ANY) discrimination.

Represents a composition of

• a converter between the domain and relational form
• a JDBC mapping to read and write the relational values

Nested Class Summary

Nested classes/interfaces inherited from interface Bindable

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

Nested classes/interfaces inherited from interface ModelPart

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

Method Summary

Modifier and Type	Method	Description
BasicFetch<?>	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
default JavaType<?>	getDomainJavaType()	The domain Java form, which is either JavaType<Class> (entity class) or JavaType<String> (entity name).
default JavaType<?>	getRelationalJavaType()	The relational Java form.
JdbcMapping	getUnderlyingJdbcMapping()
DiscriminatorConverter<?,?>	getValueConverter()	Information about the value mappings
default DiscriminatorValueDetails	resolveDiscriminatorValue(Object discriminatorValue)	Retrieve the details for a particular discriminator value.
Expression	resolveSqlExpression(NavigablePath navigablePath, JdbcMapping jdbcMappingToUse, TableGroup tableGroup, SqlAstCreationState creationState)	Create the appropriate SQL expression for this discriminator

Methods inherited from interface BasicValuedMapping

addToCacheKey, disassemble, getJdbcMapping

Methods inherited from interface BasicValuedModelPart

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

Methods inherited from interface Bindable

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

Methods inherited from interface Fetchable

getFetchableKey, getFetchableName, getMappedFetchOptions, incrementFetchDepth, isSelectable, resolveCircularFetch

Methods inherited from interface JavaTypedExpressible

addToCacheKey

Methods inherited from interface JdbcMappingContainer

forEachJdbcType

Methods inherited from interface ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, createDomainResult, decompose, decompose, findContainingEntityMapping, getJavaType, getNavigableRole, getPartName, isEntityIdentifierMapping

Methods inherited from interface SelectableMapping

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

Methods inherited from interface SqlTypedMapping

getArrayLength, getJdbcMapping, getLength, getPrecision, getScale, getTemporalPrecision, isLob, toSize

Methods inherited from interface ValuedModelPart

forEachColumn, forEachInsertable, forEachNonFormula, forEachUpdatable, getContainingTableExpression

Methods inherited from interface ValueMapping

getExpressibleJavaType, getMappedType, treatAs

Methods inherited from interface VirtualModelPart

isVirtual

Method Details

getValueConverter

@Nonnull
DiscriminatorConverter<?,?> getValueConverter()

Information about the value mappings

resolveDiscriminatorValue

@Nullable
default DiscriminatorValueDetails resolveDiscriminatorValue(@Nullable
 Object discriminatorValue)

Retrieve the details for a particular discriminator value.

Throws:

HibernateException - if there is value matching the provided one

getUnderlyingJdbcMapping

@Nonnull
JdbcMapping getUnderlyingJdbcMapping()

getDomainJavaType

@Nonnull
default JavaType<?> getDomainJavaType()

The domain Java form, which is either JavaType<Class> (entity class) or JavaType<String> (entity name).

getRelationalJavaType

@Nonnull
default JavaType<?> getRelationalJavaType()

The relational Java form. This will typically be some form of integer or character value.

resolveSqlExpression

@Nonnull
Expression resolveSqlExpression(@Nonnull
 NavigablePath navigablePath,
 @Nullable
 JdbcMapping jdbcMappingToUse,
 @Nonnull
 TableGroup tableGroup,
 @Nonnull
 SqlAstCreationState creationState)

Create the appropriate SQL expression for this discriminator

Parameters:

jdbcMappingToUse - The JDBC mapping to use. This allows opting between the "domain result type" (aka Class) and the "underlying type" (Integer, String, etc)

generateFetch

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

Description copied from interface: Fetchable

Generates a Fetch of this fetchable

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