Package org.hibernate.metamodel.mapping.internal

Class AnyDiscriminatorPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.AnyDiscriminatorPart

All Implemented Interfaces:

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

public class AnyDiscriminatorPart
extends Object
implements DiscriminatorMapping, FetchOptions

Acts as a ModelPart for the discriminator portion of an any-valued mapping

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

Modifier and Type	Field	Description
static final String	ROLE_NAME

Constructor Summary

Constructors

Constructor

Description

AnyDiscriminatorPart(NavigableRole partRole, DiscriminatedAssociationModelPart declaringType, String table, String column, SelectablePath selectablePath, String customReadExpression, String customWriteExpression, String columnDefinition, Long length, Integer precision, Integer scale, boolean insertable, boolean updateable, boolean partitioned, BasicType<?> underlyingJdbcMapping, Map<Object,String> valueToEntityNameMap, ImplicitDiscriminatorStrategy implicitValueStrategy, MappingMetamodelImplementor mappingMetamodel)

Method Summary

Modifier and Type	Method	Description
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.
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.
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
static DiscriminatorConverter<?,?>	determineDiscriminatorConverter(NavigableRole partRole, BasicType<?> underlyingJdbcMapping, Map<Object,String> valueToEntityNameMap, ImplicitDiscriminatorStrategy implicitValueStrategy, MappingMetamodelImplementor mappingMetamodel)
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
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.
int	forEachSelectable(SelectableConsumer consumer)	A short hand form of ModelPart.forEachSelectable(int, SelectableConsumer), that passes 0 as offset.
BasicFetch<?>	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
String	getColumnDefinition()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
String	getCustomReadExpression()	The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()
String	getCustomWriteExpression()	The selection's write expression accounting ColumnTransformer.write()
int	getFetchableKey()	The key that identifies this Fetchable within a FetchableContainer.
String	getFetchableName()	The name of the fetchable.
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
Long	getLength()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
MappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
String	getPartName()	The local part name, which is generally the unqualified role name
Integer	getPrecision()
Integer	getScale()
String	getSelectableName()
SelectablePath	getSelectablePath()
String	getSelectionExpression()	The selection's expression.
FetchStyle	getStyle()
Integer	getTemporalPrecision()
FetchTiming	getTiming()
JdbcMapping	getUnderlyingJdbcMapping()
DiscriminatorConverter<?,?>	getValueConverter()	Information about the value mappings
boolean	isFormula()	Is the mapping a formula instead of a physical column?
boolean	isInsertable()
boolean	isNullable()	Is the mapping considered nullable?
boolean	isPartitioned()
boolean	isUpdateable()
JdbcMapping	jdbcMapping()
Expression	resolveSqlExpression(NavigablePath navigablePath, JdbcMapping jdbcMappingToUse, TableGroup tableGroup, SqlAstCreationState creationState)	Create the appropriate SQL expression for this discriminator

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

asBasicValuedModelPart, getJdbcMapping, 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, resolveDiscriminatorValue

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

asAttributeMapping, incrementFetchDepth, isSelectable, resolveCircularFetch

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

areEqual, asEntityMappingType, breakDownJdbcValues, decompose, decompose, isEntityIdentifierMapping

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

getWriteExpression

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

isLob, toSize

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

forEachInsertable, forEachNonFormula, forEachUpdatable

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

getExpressibleJavaType, treatAs

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

isVirtual

Field Details

ROLE_NAME

public static final String ROLE_NAME

See Also:

• Constant Field Values

Constructor Details

AnyDiscriminatorPart

public AnyDiscriminatorPart(NavigableRole partRole,
 DiscriminatedAssociationModelPart declaringType,
 String table,
 String column,
 SelectablePath selectablePath,
 String customReadExpression,
 String customWriteExpression,
 String columnDefinition,
 Long length,
 Integer precision,
 Integer scale,
 boolean insertable,
 boolean updateable,
 boolean partitioned,
 BasicType<?> underlyingJdbcMapping,
 Map<Object,String> valueToEntityNameMap,
 ImplicitDiscriminatorStrategy implicitValueStrategy,
 MappingMetamodelImplementor mappingMetamodel)

Method Details

determineDiscriminatorConverter

public static DiscriminatorConverter<?,?> determineDiscriminatorConverter(NavigableRole partRole,
 BasicType<?> underlyingJdbcMapping,
 Map<Object,String> valueToEntityNameMap,
 ImplicitDiscriminatorStrategy implicitValueStrategy,
 MappingMetamodelImplementor mappingMetamodel)

getValueConverter

public DiscriminatorConverter<?,?> getValueConverter()

Description copied from interface: DiscriminatorMapping

Information about the value mappings

Specified by:

getValueConverter in interface DiscriminatorMapping

jdbcMapping

public JdbcMapping jdbcMapping()

getContainingTableExpression

public String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface SelectableMapping

Specified by:

getContainingTableExpression in interface ValuedModelPart

getSelectionExpression

public String getSelectionExpression()

Description copied from interface: SelectableMapping

The selection's expression. This is the column name or formula

Specified by:

getSelectionExpression in interface SelectableMapping

getSelectableName

public String getSelectableName()

Specified by:

getSelectableName in interface SelectableMapping

getSelectablePath

public SelectablePath getSelectablePath()

Specified by:

getSelectablePath in interface SelectableMapping

isFormula

public boolean isFormula()

Description copied from interface: SelectableMapping

Is the mapping a formula instead of a physical column?

Specified by:

isFormula in interface SelectableMapping

isNullable

public boolean isNullable()

Description copied from interface: SelectableMapping

Is the mapping considered nullable?

Specified by:

isNullable in interface SelectableMapping

isInsertable

public boolean isInsertable()

Specified by:

isInsertable in interface SelectableMapping

isUpdateable

public boolean isUpdateable()

Specified by:

isUpdateable in interface SelectableMapping

isPartitioned

public boolean isPartitioned()

Specified by:

isPartitioned in interface SelectableMapping

getCustomReadExpression

public String getCustomReadExpression()

Description copied from interface: SelectableMapping

The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()

Specified by:

getCustomReadExpression in interface SelectableMapping

getCustomWriteExpression

public String getCustomWriteExpression()

Description copied from interface: SelectableMapping

The selection's write expression accounting ColumnTransformer.write()

Specified by:

getCustomWriteExpression in interface SelectableMapping

getColumnDefinition

public String getColumnDefinition()

Specified by:

getColumnDefinition in interface SqlTypedMapping

getLength

public Long getLength()

Specified by:

getLength in interface SqlTypedMapping

getPrecision

public Integer getPrecision()

Specified by:

getPrecision in interface SqlTypedMapping

getTemporalPrecision

public Integer getTemporalPrecision()

Specified by:

getTemporalPrecision in interface SqlTypedMapping

getScale

public Integer getScale()

Specified by:

getScale in interface SqlTypedMapping

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

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

getPartName

public String getPartName()

Description copied from interface: ModelPart

The local part name, which is generally the unqualified role name

Specified by:

getPartName in interface ModelPart

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

• ModelPart.getPartName()

getUnderlyingJdbcMapping

public JdbcMapping getUnderlyingJdbcMapping()

Specified by:

getUnderlyingJdbcMapping in interface DiscriminatorMapping

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 BasicValuedMapping

Specified by:

disassemble in interface Bindable

See Also:

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 BasicValuedMapping

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible

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

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

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

getFetchableName

public String getFetchableName()

Description copied from interface: Fetchable

The name of the fetchable. This is the part's "local name".

Specified by:

getFetchableName in interface Fetchable

See Also:

• ModelPart.getNavigableRole()
• NavigableRole.getLocalName()

getFetchableKey

public int getFetchableKey()

Description copied from interface: Fetchable

The key that identifies this Fetchable within a FetchableContainer. If this Fetchable is part of FetchableContainer.visitFetchables(IndexedConsumer, EntityMappingType), the values is guaranteed to be between 0 (inclusive) and FetchableContainer.getNumberOfFetchableKeys() (exclusive). Other Fetchable objects may have a special negative value.

The main intent of this key is to index e.g. Fetch objects in an array.

Specified by:

getFetchableKey in interface Fetchable

getMappedFetchOptions

public FetchOptions getMappedFetchOptions()

Description copied from interface: Fetchable

The configured fetch timing and style

Specified by:

getMappedFetchOptions in interface Fetchable

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

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 BasicValuedModelPart

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

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)

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 DiscriminatorMapping

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

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess

createDomainResult

public <T> DomainResult<T> 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

resolveSqlExpression

public Expression resolveSqlExpression(NavigablePath navigablePath,
 JdbcMapping jdbcMappingToUse,
 TableGroup tableGroup,
 SqlAstCreationState creationState)

Description copied from interface: DiscriminatorMapping

Create the appropriate SQL expression for this discriminator

Specified by:

resolveSqlExpression in interface DiscriminatorMapping

Parameters:

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

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