Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.metamodel.mapping.internal.AnyKeyPart

Field Summary

Modifier and Type	Field and Description
private final DiscriminatedAssociationModelPart	anyPart
private final String	column
private final String	columnDefinition
private final boolean	insertable
private final JdbcMapping	jdbcMapping
public static final String	KEY_NAME
private final Long	length
private final NavigableRole	navigableRole
private final boolean	nullable
private final boolean	partitioned
private final Integer	precision
private final Integer	scale
private final String	table
private final boolean	updateable

Constructor Summary

Access	Constructor and Description
public	AnyKeyPart(NavigableRole navigableRole, DiscriminatedAssociationModelPart anyPart, String table, String column, String columnDefinition, Long length, Integer precision, Integer scale, boolean nullable, boolean insertable, boolean updateable, boolean partitioned, JdbcMapping jdbcMapping)

Method Summary

Modifier and Type	Method and Description
public void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
public void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection, JdbcMapping> selectionConsumer) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
public <X, Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X, Y> valueConsumer, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues. Breaks down the domain value to its constituent JDBC values.
public <T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ModelPart.createDomainResult. Create a DomainResult for a specific reference to this ModelPart.
public Object	disassemble(Object value, SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.BasicValuedMapping.disassemble. Implements org.hibernate.metamodel.mapping.Bindable.disassemble. Breaks down a value of `J` into its simple pieces.
public EntityMappingType	findContainingEntityMapping() Implements org.hibernate.metamodel.mapping.ModelPart.findContainingEntityMapping.
public <X, Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X, Y> valuesConsumer, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.Bindable.forEachDisassembledJdbcValue. Like `forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor)`, but additionally receives an offset by which the selectionIndex is incremented when calling `JdbcValuesBiConsumer#consume(int, Object, Object, Object, JdbcMapping)`.
public int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action) Implements org.hibernate.metamodel.mapping.JdbcMappingContainer.forEachJdbcType. Visit each JdbcMapping starting from the given offset
public <X, Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X, Y> valuesConsumer, SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.Bindable.forEachJdbcValue. Visit each constituent JDBC value extracted from the entity instance itself.
public int	forEachSelectable(int offset, SelectableConsumer consumer) Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.forEachSelectable. Visits each selectable mapping with the selectable index offset by the given value.
public Fetch	generateFetch(FetchParent The parent of the Fetch we are generating fetchParent, NavigablePath The overall path within the graph fetchablePath, FetchTiming The requested fetch timing fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.sql.results.graph.Fetchable.generateFetch. Generates a Fetch of this fetchable
public String	getColumnDefinition() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getColumnDefinition.
public String	getContainingTableExpression() Implements org.hibernate.metamodel.mapping.ValuedModelPart.getContainingTableExpression, org.hibernate.metamodel.mapping.SelectableMapping.getContainingTableExpression. The table which contains the columns mapped by this value
public String	getCustomReadExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomReadExpression. The selection's read expression accounting for formula treatment as well as `ColumnTransformer#read()`
public String	getCustomWriteExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getCustomWriteExpression. The selection's write expression accounting `ColumnTransformer#write()`
public int	getFetchableKey() Implements org.hibernate.sql.results.graph.Fetchable.getFetchableKey. The key that identifies this Fetchable within a `FetchableContainer`.
public String	getFetchableName() Implements org.hibernate.sql.results.graph.Fetchable.getFetchableName. The name of the fetchable.
public JavaType<?>	getJavaType() Implements org.hibernate.metamodel.mapping.ModelPart.getJavaType. The Java type for this part.
public JdbcMapping	getJdbcMapping() Implements org.hibernate.metamodel.mapping.BasicValuedMapping.getJdbcMapping, org.hibernate.metamodel.mapping.SqlTypedMapping.getJdbcMapping. Anything that is expressible at the SQL AST level would be of basic type.
public JdbcMapping	getJdbcMapping(int index) Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.getJdbcMapping.
public Long	getLength() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getLength.
public FetchOptions	getMappedFetchOptions() Implements org.hibernate.sql.results.graph.Fetchable.getMappedFetchOptions. The configured fetch timing and style
public MappingType	getMappedType() Implements org.hibernate.metamodel.mapping.ValueMapping.getMappedType. Descriptor for the type of this mapping
public NavigableRole	getNavigableRole() Implements org.hibernate.metamodel.mapping.ModelPart.getNavigableRole.
public String	getPartName() Implements org.hibernate.metamodel.mapping.ModelPart.getPartName. The local part name, which is generally the unqualified role name
public Integer	getPrecision() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getPrecision.
public Integer	getScale() Implements org.hibernate.metamodel.mapping.SqlTypedMapping.getScale.
public String	getSelectionExpression() Implements org.hibernate.metamodel.mapping.SelectableMapping.getSelectionExpression. The selection's expression.
public JdbcMapping	getSingleJdbcMapping() Overrides default org.hibernate.metamodel.mapping.BasicValuedModelPart.getSingleJdbcMapping.
public FetchStyle	getStyle() Implements org.hibernate.sql.results.graph.FetchStyleAccess.getStyle.
public FetchTiming	getTiming() Implements org.hibernate.sql.results.graph.FetchTimingAccess.getTiming.
public boolean	isFormula() Implements org.hibernate.metamodel.mapping.SelectableMapping.isFormula. Is the mapping a formula instead of a physical column?
public boolean	isInsertable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isInsertable.
public boolean	isNullable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isNullable. Is the mapping considered nullable?
public boolean	isPartitioned() Implements org.hibernate.metamodel.mapping.SelectableMapping.isPartitioned.
public boolean	isUpdateable() Implements org.hibernate.metamodel.mapping.SelectableMapping.isUpdateable.
private SqlSelection	resolveSqlSelection(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

anyPart	back to summary
private final DiscriminatedAssociationModelPart anyPart

column	back to summary
private final String column

columnDefinition	back to summary
private final String columnDefinition

insertable	back to summary
private final boolean insertable

jdbcMapping	back to summary
private final JdbcMapping jdbcMapping

KEY_NAME	back to summary
public static final String KEY_NAME

length	back to summary
private final Long length

navigableRole	back to summary
private final NavigableRole navigableRole

nullable	back to summary
private final boolean nullable

partitioned	back to summary
private final boolean partitioned

precision	back to summary
private final Integer precision

scale	back to summary
private final Integer scale

table	back to summary
private final String table

updateable	back to summary
private final boolean updateable

Constructor Detail

AnyKeyPart	back to summary
public AnyKeyPart(NavigableRole navigableRole, DiscriminatedAssociationModelPart anyPart, String table, String column, String columnDefinition, Long length, Integer precision, Integer scale, boolean nullable, boolean insertable, boolean updateable, boolean partitioned, JdbcMapping jdbcMapping)

Method Detail

applySqlSelections	back to summary
public void applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Doc from org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause. Annotations @Override

applySqlSelections	back to summary
public void applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection, JdbcMapping> selectionConsumer) Implements org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Doc from org.hibernate.metamodel.mapping.ModelPart.applySqlSelections. Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause. Annotations @Override

breakDownJdbcValues back to summary

breakDownJdbcValues	back to summary
public <X, Y> int breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X, Y> valueConsumer, SharedSessionContractImplementor session) Implements org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues. Doc from org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues. 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. Annotations @Override

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

Implements org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues.

Doc from org.hibernate.metamodel.mapping.ModelPart.breakDownJdbcValues.

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.

Annotations

@Override

createDomainResult	back to summary
public <T> DomainResult<T> createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState) Implements org.hibernate.metamodel.mapping.ModelPart.createDomainResult. Doc from org.hibernate.metamodel.mapping.ModelPart.createDomainResult. Create a DomainResult for a specific reference to this ModelPart. Annotations @Override

disassemble back to summary

disassemble	back to summary
public Object disassemble(Object value, SharedSessionContractImplementor session) Overrides default org.hibernate.metamodel.mapping.BasicValuedMapping.disassemble. Implements org.hibernate.metamodel.mapping.Bindable.disassemble. Doc from org.hibernate.metamodel.mapping.Bindable.disassemble. 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. Annotations @Override

public Object disassemble(Object value, SharedSessionContractImplementor session)

Overrides default org.hibernate.metamodel.mapping.BasicValuedMapping.disassemble.

Implements org.hibernate.metamodel.mapping.Bindable.disassemble.

Doc from org.hibernate.metamodel.mapping.Bindable.disassemble.

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.