Package org.hibernate.metamodel.mapping.internal

Class BasicAttributeMapping

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractAttributeMapping

org.hibernate.metamodel.mapping.internal.AbstractStateArrayContributorMapping

org.hibernate.metamodel.mapping.internal.AbstractSingularAttributeMapping

org.hibernate.metamodel.mapping.internal.BasicAttributeMapping

All Implemented Interfaces:

AttributeMapping, BasicValuedMapping, BasicValuedModelPart, Bindable, JdbcMappingContainer, MappingModelExpressible, ModelPart, OwnedValuedModelPart, PropertyBasedMapping, SelectableMapping, SelectableMappings, SingularAttributeMapping, SqlExpressible, SqlTypedMapping, ValuedModelPart, ValueMapping, DatabaseSnapshotContributor, Fetchable, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible, MutabilityPlanExposer

public class BasicAttributeMapping
extends AbstractSingularAttributeMapping
implements SingularAttributeMapping, BasicValuedModelPart

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

Constructor Summary

Constructors

Constructor

Description

BasicAttributeMapping(String attributeName, NavigableRole navigableRole, int stateArrayPosition, int fetchableIndex, AttributeMetadata attributeMetadata, FetchTiming mappedFetchTiming, FetchStyle mappedFetchStyle, String tableExpression, String mappedColumnExpression, SelectablePath selectablePath, boolean isFormula, String customReadExpression, String customWriteExpression, String columnDefinition, Long length, Integer precision, Integer scale, Integer temporalPrecision, boolean isLob, boolean nullable, boolean insertable, boolean updateable, boolean partitioned, JdbcMapping jdbcMapping, ManagedMappingType declaringType, PropertyAccess propertyAccess)

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.
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
<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.
Fetch	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()
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()
MappingType	getMappedType()	Descriptor for the type of this mapping
NavigableRole	getNavigableRole()
Integer	getPrecision()
Integer	getScale()
String	getSelectableName()
SelectablePath	getSelectablePath()
String	getSelectionExpression()	The selection's expression.
Integer	getTemporalPrecision()
String	getWriteExpression()
boolean	isFormula()	Is the mapping a formula instead of a physical column?
boolean	isInsertable()
boolean	isLazy()
boolean	isLob()
boolean	isNullable()	Is the mapping considered nullable?
boolean	isPartitioned()
boolean	isUpdateable()
String	toString()
static BasicAttributeMapping	withSelectableMapping(ManagedMappingType declaringType, BasicValuedModelPart original, PropertyAccess propertyAccess, boolean insertable, boolean updateable, SelectableMapping selectableMapping)

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractSingularAttributeMapping

getGenerator

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractStateArrayContributorMapping

getFetchableName, getMappedFetchOptions, getStyle, getTiming

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractAttributeMapping

getAttributeMetadata, getAttributeName, getDeclaringType, getFetchableKey, getPartMappingType, getPropertyAccess, getStateArrayPosition

Methods inherited from class java.lang.Object

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

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

asAttributeMapping, asEmbeddedAttributeMapping, asPluralAttributeMapping, compare, findContainingEntityMapping, getAttributeMetadata, getAttributeName, getDeclaringType, getExposedMutabilityPlan, getGenerator, getPartName, getPropertyAccess, getStateArrayPosition, getValue, isEmbeddedAttributeMapping, isPluralAttributeMapping, setValue

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

addToCacheKey, disassemble

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

asBasicValuedModelPart, forEachSelectable, 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.sql.results.graph.DatabaseSnapshotContributor

createSnapshotDomainResult

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

getFetchableKey, getFetchableName, getMappedFetchOptions, 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, isVirtual

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

toSize

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

forEachInsertable, forEachNonFormula, forEachUpdatable, getJdbcTypeCount, getSingleJdbcMapping

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

getExpressibleJavaType, treatAs

Constructor Details

BasicAttributeMapping

public BasicAttributeMapping(String attributeName,
 NavigableRole navigableRole,
 int stateArrayPosition,
 int fetchableIndex,
 AttributeMetadata attributeMetadata,
 FetchTiming mappedFetchTiming,
 FetchStyle mappedFetchStyle,
 String tableExpression,
 String mappedColumnExpression,
 SelectablePath selectablePath,
 boolean isFormula,
 String customReadExpression,
 String customWriteExpression,
 String columnDefinition,
 Long length,
 Integer precision,
 Integer scale,
 Integer temporalPrecision,
 boolean isLob,
 boolean nullable,
 boolean insertable,
 boolean updateable,
 boolean partitioned,
 JdbcMapping jdbcMapping,
 ManagedMappingType declaringType,
 PropertyAccess propertyAccess)

Method Details

withSelectableMapping

public static BasicAttributeMapping withSelectableMapping(ManagedMappingType declaringType,
 BasicValuedModelPart original,
 PropertyAccess propertyAccess,
 boolean insertable,
 boolean updateable,
 SelectableMapping selectableMapping)

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

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

Overrides:

getJavaType in class AbstractAttributeMapping

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

isLob

public boolean isLob()

Specified by:

isLob in interface SqlTypedMapping

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

isLazy

public boolean isLazy()

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

getWriteExpression

public String getWriteExpression()

Specified by:

getWriteExpression 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

getScale

public Integer getScale()

Specified by:

getScale in interface SqlTypedMapping

getTemporalPrecision

public Integer getTemporalPrecision()

Specified by:

getTemporalPrecision in interface SqlTypedMapping

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

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

• ModelPart.getPartName()

toString

public String toString()

Overrides:

toString in class Object

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

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

generateFetch

public Fetch 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 Fetchable

Parameters:

fetchParent - The parent of the Fetch we are generating

fetchablePath - The overall path within the graph

fetchTiming - The requested fetch timing

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

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)

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