Package org.hibernate.metamodel.mapping.internal

Class BasicValuedCollectionPart

java.lang.Object

org.hibernate.metamodel.mapping.internal.BasicValuedCollectionPart

All Implemented Interfaces:

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

public class BasicValuedCollectionPart
extends Object
implements CollectionPart, BasicValuedModelPart, FetchOptions

Models a basic collection element/value or index/key

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

CollectionPart.Nature

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

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

Constructor Summary

Constructors

Constructor	Description
BasicValuedCollectionPart(CollectionPersister collectionDescriptor, CollectionPart.Nature nature, SelectableMapping selectableMapping)

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	decompose(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions.
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.
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()
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.
JdbcMapping	getJdbcMapping(int index)
List<JdbcMapping>	getJdbcMappings()	Deprecated, for removal: This API element is subject to removal in a future version.
Long	getLength()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
MappingType	getMappedType()	Descriptor for the type of this mapping
CollectionPart.Nature	getNature()
NavigableRole	getNavigableRole()
MappingType	getPartMappingType()	The type for this part.
Integer	getPrecision()
Integer	getScale()
String	getSelectionExpression()	The selection's expression.
JdbcMapping	getSingleJdbcMapping()
FetchStyle	getStyle()
FetchTiming	getTiming()
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()
String	toString()

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

addToCacheKey, disassemble

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

asBasicValuedModelPart, forEachSelectable, getJdbcTypeCount, getSelectable, 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.CollectionPart

getInclusionCheckPart, getPartName

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, isEntityIdentifierMapping, isVirtual

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

getSelectableName, getSelectablePath, getWriteExpression

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

isLob

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

forEachInsertable, forEachNonFormula, forEachUpdatable, getJdbcTypeCount

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

getExpressibleJavaType, treatAs

Constructor Detail

BasicValuedCollectionPart

public BasicValuedCollectionPart(CollectionPersister collectionDescriptor,
                                 CollectionPart.Nature nature,
                                 SelectableMapping selectableMapping)

Method Detail

getNature

public CollectionPart.Nature getNature()

Specified by:

getNature in interface CollectionPart

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface BasicValuedModelPart

Specified by:

getPartMappingType in interface ModelPart

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

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

isPartitioned

public boolean isPartitioned()

Specified by:

isPartitioned in interface SelectableMapping

isUpdateable

public boolean isUpdateable()

Specified by:

isUpdateable 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

getScale

public Integer getScale()

Specified by:

getScale 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

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

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

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

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

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

getJdbcMappings

@Deprecated(forRemoval=true)
public List<JdbcMapping> getJdbcMappings()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Bindable

The list of JDBC mappings

Specified by:

getJdbcMappings in interface BasicValuedMapping

Specified by:

getJdbcMappings in interface BasicValuedModelPart

Specified by:

getJdbcMappings in interface Bindable

Specified by:

getJdbcMappings in interface JdbcMappingContainer

Specified by:

getJdbcMappings in interface SelectableMappings

Specified by:

getJdbcMappings in interface ValuedModelPart

See Also:

SqlTypedMapping.getJdbcMapping()

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface BasicValuedModelPart

Specified by:

getJdbcMapping in interface JdbcMappingContainer

Specified by:

getJdbcMapping in interface SqlExpressible

getSingleJdbcMapping

public JdbcMapping getSingleJdbcMapping()

Specified by:

getSingleJdbcMapping in interface BasicValuedMapping

Specified by:

getSingleJdbcMapping in interface BasicValuedModelPart

Specified by:

getSingleJdbcMapping in interface JdbcMappingContainer

Specified by:

getSingleJdbcMapping in interface ValuedModelPart

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess

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

decompose

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

Description copied from interface: ModelPart

Similar to ModelPart.breakDownJdbcValues(Object, int, Object, Object, JdbcValueBiConsumer, SharedSessionContractImplementor), but this method is supposed to be used for decomposing values for assignment expressions. Returns the amount of jdbc types that have been visited.

Specified by:

decompose 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