Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.model.internal.BinderHelper

Modifier and Type	Field and Description
public static final Set<String>	PRIMITIVE_NAMES

Access	Constructor and Description
private	BinderHelper()

Method Summary

Modifier and Type	Method and Description
private static String	associationMessage(PersistentClass associatedEntity, AnnotatedJoinColumns joinColumns)
public static Any	buildAnyValue(Column discriminatorColumn, Formula discriminatorFormula, AnnotatedJoinColumns keyColumns, PropertyData inferredData, OnDeleteAction onDeleteAction, boolean lazy, Nullability nullability, PropertyHolder propertyHolder, EntityBinder entityBinder, boolean optional, MetadataBuildingContext context)
private static void	checkColumnInSameTable(AnnotatedJoinColumns joinColumns, PersistentClass targetEntity, PersistentClass associatedEntity, MetadataBuildingContext context, Object columnOwner) All the referenced columns must belong to the same table, that is `findColumnOwner(PersistentClass, String, MetadataBuildingContext)` must return the same value for all of them.
public static void	checkMappedByType(String mappedBy, Value targetValue, String propertyName, PropertyHolder propertyHolder, Map<String, PersistentClass> persistentClasses)
private static boolean	checkReferencedClass(PersistentClass ownerClass, PersistentClass referencedClass)
private static Property	cloneProperty(PersistentClass ownerEntity, MetadataBuildingContext context, Property property) Create a (deep) copy of the `Property`, by also recursively cloning any child `Component` instances, but reusing other kinds of `Value` and other attributes.
private static CascadeType	convertCascadeType(CascadeType cascade)
private static EnumSet<CascadeType>	convertToHibernateCascadeType(CascadeType[] ejbCascades)
public static void	createSyntheticPropertyReference(AnnotatedJoinColumns joinColumns, PersistentClass targetEntity, PersistentClass associatedEntity, Value value, String propertyName, boolean inverse, MetadataBuildingContext context) Here we address a fundamental problem: the `@JoinColumn` annotation specifies the referenced column in the target table via `referencedColumnName`, but Hibernate needs to know which property or field of the target entity class holds the value of the referenced column at the Java level.
public static <A extends Annotation> A	Returns: The annotation or `null` extractFromPackage(Class<A> The type of annotation to return annotationType, XClass The class in the package xClass, MetadataBuildingContext The processing context context) Extract an annotation from the package-info for the package the given class is defined in
public static AttributeContainer	findColumnOwner(PersistentClass persistentClass, String columnName, MetadataBuildingContext context) Find the column owner (ie PersistentClass or Join) of columnName.
private static List<Property>	findPropertiesByColumns(Object columnOwner, AnnotatedJoinColumns columns, PersistentClass associatedEntity, MetadataBuildingContext context)
public static Property	findPropertyByName(PersistentClass associatedClass, String propertyName) Retrieve the property by path in a recursive way, including IdentifierProperty in the loop If propertyName is null or empty, the IdentifierProperty is returned
public static Property	findPropertyByName(Component component, String propertyName) Retrieve the property by path in a recursive way
public static AttributeContainer	findReferencedColumnOwner(PersistentClass persistentClass, AnnotatedJoinColumn joinColumn, MetadataBuildingContext context)
public static String	getCascadeStrategy(CascadeType[] ejbCascades, Cascade hibernateCascadeAnnotation, boolean orphanRemoval, boolean forcePersist)
public static FetchMode	getFetchMode(FetchType fetch)
public static MappedSuperclass	getMappedSuperclassOrNull(XClass declaringClass, Map<XClass, InheritanceState> inheritanceStatePerClass, MetadataBuildingContext context)
public static <T extends Annotation> T	getOverridableAnnotation(XAnnotatedElement element, Class<T> annotationType, MetadataBuildingContext context)
public static String	getPath(PropertyHolder holder, PropertyData property)
pack-priv static PropertyData	getPropertyOverriddenByMapperOrMapsId(boolean isId, PropertyHolder propertyHolder, String propertyName, MetadataBuildingContext buildingContext)
public static String	getRelativePath(PropertyHolder propertyHolder, String propertyName)
public static boolean	hasToOneAnnotation(XAnnotatedElement property)
pack-priv static boolean	isCompositeId(XClass entityClass, XProperty idProperty)
public static boolean	isDefault(XClass clazz, MetadataBuildingContext context)
pack-priv static boolean	isGlobalGeneratorNameGlobal(MetadataBuildingContext context)
public static boolean	isPrimitive(String elementTypeName)
private static Property	makeSyntheticComponentProperty(PersistentClass ownerEntity, AttributeContainer persistentClassOrJoin, MetadataBuildingContext context, String syntheticPropertyName, List<Property> properties) Build the "synthetic" `Component` that holds all the properties referenced by a foreign key mapping specified as a list of `jakarta.persistence.JoinColumn` annotations with explicit `referencedColumnName()`s.
private static void	matchColumnsByProperty(Property property, Map<Column, Set<Property>> columnsToProperty)
public static boolean	noConstraint(ForeignKey foreignKey, boolean noConstraintByDefault)
private static void	processAnyDiscriminatorValues(XProperty property, Consumer<AnyDiscriminatorValue> consumer)
private static Property	referencedProperty(PersistentClass ownerEntity, PersistentClass associatedEntity, String propertyName, boolean inverse, AttributeContainer columnOwner, List<Property> properties, MetadataBuildingContext context) If the referenced columns correspond to exactly one property of the primary table of the exact target entity subclass, just use that property.
private static void	registerSyntheticProperty(PersistentClass ownerEntity, Value value, boolean inverse, PersistentClass associatedClass, String propertyName, String syntheticPropertyName, MetadataBuildingContext context)
private static String	renderCascadeTypeList(EnumSet<CascadeType> cascadeTypes)
public static Property	shallowCopy(Property property) Create a copy of the `Property`, reusing the same `Value` and other attributes.
private static String	syntheticPropertyName(String propertyName, boolean inverse, PersistentClass associatedClass)
public static Map<String, String>	toAliasEntityMap(SqlFragmentAlias[] aliases)
public static Map<String, String>	toAliasTableMap(SqlFragmentAlias[] aliases)

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

PRIMITIVE_NAMES	back to summary
public static final Set<String> PRIMITIVE_NAMES

BinderHelper	back to summary
private BinderHelper()

Method Detail

associationMessage	back to summary
private static String associationMessage(PersistentClass associatedEntity, AnnotatedJoinColumns joinColumns)

buildAnyValue	back to summary
public static Any buildAnyValue(Column discriminatorColumn, Formula discriminatorFormula, AnnotatedJoinColumns keyColumns, PropertyData inferredData, OnDeleteAction onDeleteAction, boolean lazy, Nullability nullability, PropertyHolder propertyHolder, EntityBinder entityBinder, boolean optional, MetadataBuildingContext context)

checkColumnInSameTable	back to summary
private static void checkColumnInSameTable(AnnotatedJoinColumns joinColumns, PersistentClass targetEntity, PersistentClass associatedEntity, MetadataBuildingContext context, Object columnOwner) All the referenced columns must belong to the same table, that is `findColumnOwner(PersistentClass, String, MetadataBuildingContext)` must return the same value for all of them.

checkMappedByType	back to summary
public static void checkMappedByType(String mappedBy, Value targetValue, String propertyName, PropertyHolder propertyHolder, Map<String, PersistentClass> persistentClasses)

checkReferencedClass	back to summary
private static boolean checkReferencedClass(PersistentClass ownerClass, PersistentClass referencedClass)

cloneProperty	back to summary
private static Property cloneProperty(PersistentClass ownerEntity, MetadataBuildingContext context, Property property) Create a (deep) copy of the `Property`, by also recursively cloning any child `Component` instances, but reusing other kinds of `Value` and other attributes.

convertCascadeType	back to summary
private static CascadeType convertCascadeType(CascadeType cascade)

convertToHibernateCascadeType	back to summary
private static EnumSet<CascadeType> convertToHibernateCascadeType(CascadeType[] ejbCascades)

createSyntheticPropertyReference back to summary

public static void createSyntheticPropertyReference(AnnotatedJoinColumns joinColumns, PersistentClass targetEntity, PersistentClass associatedEntity, Value value, String propertyName, boolean inverse, MetadataBuildingContext context)

Here we address a fundamental problem: the @JoinColumn annotation specifies the referenced column in the target table via referencedColumnName, but Hibernate needs to know which property or field of the target entity class holds the value of the referenced column at the Java level. (It's going to need the value when it writes the association.)

Complicating this hugely is the fact that an association might be based on a composite key with multiple @JoinColumns, and so the referenced columns might even be spread out over multiple fields or properties of the target entity. There's even some extra minor complications resulting from multi-table inheritance and secondary tables.

The solution here is:

if the referenced columns correspond to exactly one property of the target entity, we're good, just use it, or
otherwise, if a composite key is spread out over multiple properties, then create a "synthetic" Component in the model that aggregates these properties and is considered the target of the association.

Certain limitations arise from the way this solution is currently implemented: for example, if a referenced column belongs to a property of an @Embeddable, then every column of that embeddable must occur in the list of referenced columns, and the order of the columns must line up! Some of these limitations could be relaxed by writing a better algorithm for building the synthetic Component.

extractFromPackage back to summary

public static <A extends Annotation> A extractFromPackage(Class<A> annotationType, XClass xClass, MetadataBuildingContext context)

Extract an annotation from the package-info for the package the given class is defined in

Parameters

annotationType:Class<A>: The type of annotation to return
xClass:XClass: The class in the package
context:MetadataBuildingContext: The processing context

Returns:A

The annotation or null

findColumnOwner	back to summary
public static AttributeContainer findColumnOwner(PersistentClass persistentClass, String columnName, MetadataBuildingContext context) Find the column owner (ie PersistentClass or Join) of columnName. If columnName is null or empty, persistentClass is returned

findPropertiesByColumns	back to summary
private static List<Property> findPropertiesByColumns(Object columnOwner, AnnotatedJoinColumns columns, PersistentClass associatedEntity, MetadataBuildingContext context)

findPropertyByName	back to summary
public static Property findPropertyByName(PersistentClass associatedClass, String propertyName) Retrieve the property by path in a recursive way, including IdentifierProperty in the loop If propertyName is null or empty, the IdentifierProperty is returned

findPropertyByName	back to summary
public static Property findPropertyByName(Component component, String propertyName) Retrieve the property by path in a recursive way

findReferencedColumnOwner	back to summary
public static AttributeContainer findReferencedColumnOwner(PersistentClass persistentClass, AnnotatedJoinColumn joinColumn, MetadataBuildingContext context)

getCascadeStrategy	back to summary
public static String getCascadeStrategy(CascadeType[] ejbCascades, Cascade hibernateCascadeAnnotation, boolean orphanRemoval, boolean forcePersist)

getFetchMode	back to summary
public static FetchMode getFetchMode(FetchType fetch)

getMappedSuperclassOrNull	back to summary
public static MappedSuperclass getMappedSuperclassOrNull(XClass declaringClass, Map<XClass, InheritanceState> inheritanceStatePerClass, MetadataBuildingContext context)

getOverridableAnnotation	back to summary
public static <T extends Annotation> T getOverridableAnnotation(XAnnotatedElement element, Class<T> annotationType, MetadataBuildingContext context)

getPath	back to summary
public static String getPath(PropertyHolder holder, PropertyData property)

getPropertyOverriddenByMapperOrMapsId	back to summary
pack-priv static PropertyData getPropertyOverriddenByMapperOrMapsId(boolean isId, PropertyHolder propertyHolder, String propertyName, MetadataBuildingContext buildingContext)

getRelativePath	back to summary
public static String getRelativePath(PropertyHolder propertyHolder, String propertyName)

hasToOneAnnotation	back to summary
public static boolean hasToOneAnnotation(XAnnotatedElement property)

isCompositeId	back to summary
pack-priv static boolean isCompositeId(XClass entityClass, XProperty idProperty)

isDefault	back to summary
public static boolean isDefault(XClass clazz, MetadataBuildingContext context)

isGlobalGeneratorNameGlobal	back to summary
pack-priv static boolean isGlobalGeneratorNameGlobal(MetadataBuildingContext context)

isPrimitive	back to summary
public static boolean isPrimitive(String elementTypeName)

makeSyntheticComponentProperty back to summary

private static Property makeSyntheticComponentProperty(PersistentClass ownerEntity, AttributeContainer persistentClassOrJoin, MetadataBuildingContext context, String syntheticPropertyName, List<Property> properties)

Build the "synthetic" Component that holds all the properties referenced by a foreign key mapping specified as a list of jakarta.persistence.JoinColumn annotations with explicit referencedColumnName()s.

matchColumnsByProperty	back to summary
private static void matchColumnsByProperty(Property property, Map<Column, Set<Property>> columnsToProperty)

noConstraint	back to summary
public static boolean noConstraint(ForeignKey foreignKey, boolean noConstraintByDefault)

processAnyDiscriminatorValues	back to summary
private static void processAnyDiscriminatorValues(XProperty property, Consumer<AnyDiscriminatorValue> consumer)

referencedProperty back to summary

private static Property referencedProperty(PersistentClass ownerEntity, PersistentClass associatedEntity, String propertyName, boolean inverse, AttributeContainer columnOwner, List<Property> properties, MetadataBuildingContext context)

If the referenced columns correspond to exactly one property of the primary table of the exact target entity subclass, just use that property. Otherwise, if a composite key is spread out over multiple properties, then create a "synthetic" Component that aggregates these properties and is considered the target of the association. This method adds the property holding the synthetic component to the target entity PersistentClass by side effect.

registerSyntheticProperty	back to summary
private static void registerSyntheticProperty(PersistentClass ownerEntity, Value value, boolean inverse, PersistentClass associatedClass, String propertyName, String syntheticPropertyName, MetadataBuildingContext context)

renderCascadeTypeList	back to summary
private static String renderCascadeTypeList(EnumSet<CascadeType> cascadeTypes)

shallowCopy	back to summary
public static Property shallowCopy(Property property) Create a copy of the `Property`, reusing the same `Value` and other attributes.

syntheticPropertyName	back to summary
private static String syntheticPropertyName(String propertyName, boolean inverse, PersistentClass associatedClass)

toAliasEntityMap	back to summary
public static Map<String, String> toAliasEntityMap(SqlFragmentAlias[] aliases)

toAliasTableMap	back to summary
public static Map<String, String> toAliasTableMap(SqlFragmentAlias[] aliases)

public Class BinderHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail