Package org.hibernate.cfg

Class BinderHelper

java.lang.Object

org.hibernate.cfg.BinderHelper

public class BinderHelper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static Set<String>	PRIMITIVE_NAMES

Method Summary

Modifier and Type	Method	Description
static Any	buildAnyValue(jakarta.persistence.Column discriminatorColumn, Formula discriminatorFormula, AnnotatedJoinColumn[] keyColumns, PropertyData inferredData, boolean cascadeOnDelete, boolean lazy, Nullability nullability, PropertyHolder propertyHolder, EntityBinder entityBinder, boolean optional, MetadataBuildingContext context)
static void	createSyntheticPropertyReference(AnnotatedJoinColumn[] columns, PersistentClass ownerEntity, PersistentClass associatedEntity, Value value, 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.
static AttributeContainer	findColumnOwner(PersistentClass persistentClass, String columnName, MetadataBuildingContext context)	Find the column owner (ie PersistentClass or Join) of columnName.
static Property	findPropertyByName(Component component, String propertyName)	Retrieve the property by path in a recursive way
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
static String	getAnnotationValueStringOrNull(String value)
static MappedSuperclass	getMappedSuperclassOrNull(org.hibernate.annotations.common.reflection.XClass declaringClass, Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass, MetadataBuildingContext context)
static <T extends Annotation> T	getOverridableAnnotation(org.hibernate.annotations.common.reflection.XAnnotatedElement element, Class<T> annotationType, MetadataBuildingContext context)
static String	getPath(PropertyHolder holder, PropertyData property)
static String	getRelativePath(PropertyHolder propertyHolder, String propertyName)
static boolean	hasToOneAnnotation(org.hibernate.annotations.common.reflection.XAnnotatedElement property)
static boolean	isEmptyAnnotationValue(String annotationString)
static boolean	isEmptyOrNullAnnotationValue(String annotationString)
static void	makeIdGenerator(SimpleValue id, org.hibernate.annotations.common.reflection.XProperty idXProperty, String generatorType, String generatorName, MetadataBuildingContext buildingContext, Map<String,IdentifierGeneratorDefinition> localGenerators)	apply an id generator to a SimpleValue
static void	makeIdGenerator(SimpleValue id, org.hibernate.annotations.common.reflection.XProperty idXProperty, String generatorType, String generatorName, MetadataBuildingContext buildingContext, IdentifierGeneratorDefinition foreignKGeneratorDefinition)	apply an id generator to a SimpleValue
static Property	shallowCopy(Property property)	create a property copy reusing the same value
static Map<String,String>	toAliasEntityMap(SqlFragmentAlias[] aliases)
static Map<String,String>	toAliasTableMap(SqlFragmentAlias[] aliases)

Methods inherited from class java.lang.Object

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

Field Detail

PRIMITIVE_NAMES

public static final Set<String> PRIMITIVE_NAMES

Method Detail

shallowCopy

public static Property shallowCopy(Property property)

create a property copy reusing the same value

createSyntheticPropertyReference

public static void createSyntheticPropertyReference(AnnotatedJoinColumn[] columns,
                                                    PersistentClass ownerEntity,
                                                    PersistentClass associatedEntity,
                                                    Value value,
                                                    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 using by writing a better algorithm for building the synthetic Component.

findPropertyByName

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

public static Property findPropertyByName(Component component,
                                          String propertyName)

Retrieve the property by path in a recursive way

getRelativePath

public static String getRelativePath(PropertyHolder propertyHolder,
                                     String propertyName)

findColumnOwner

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

makeIdGenerator

public static void makeIdGenerator(SimpleValue id,
                                   org.hibernate.annotations.common.reflection.XProperty idXProperty,
                                   String generatorType,
                                   String generatorName,
                                   MetadataBuildingContext buildingContext,
                                   Map<String,IdentifierGeneratorDefinition> localGenerators)

apply an id generator to a SimpleValue

makeIdGenerator

public static void makeIdGenerator(SimpleValue id,
                                   org.hibernate.annotations.common.reflection.XProperty idXProperty,
                                   String generatorType,
                                   String generatorName,
                                   MetadataBuildingContext buildingContext,
                                   IdentifierGeneratorDefinition foreignKGeneratorDefinition)

apply an id generator to a SimpleValue

isEmptyAnnotationValue

public static boolean isEmptyAnnotationValue(String annotationString)

isEmptyOrNullAnnotationValue

public static boolean isEmptyOrNullAnnotationValue(String annotationString)

getAnnotationValueStringOrNull

public static String getAnnotationValueStringOrNull(String value)

buildAnyValue

public static Any buildAnyValue(jakarta.persistence.Column discriminatorColumn,
                                Formula discriminatorFormula,
                                AnnotatedJoinColumn[] keyColumns,
                                PropertyData inferredData,
                                boolean cascadeOnDelete,
                                boolean lazy,
                                Nullability nullability,
                                PropertyHolder propertyHolder,
                                EntityBinder entityBinder,
                                boolean optional,
                                MetadataBuildingContext context)

getMappedSuperclassOrNull

public static MappedSuperclass getMappedSuperclassOrNull(org.hibernate.annotations.common.reflection.XClass declaringClass,
                                                         Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass,
                                                         MetadataBuildingContext context)

getPath

public static String getPath(PropertyHolder holder,
                             PropertyData property)

toAliasTableMap

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

toAliasEntityMap

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

hasToOneAnnotation

public static boolean hasToOneAnnotation(org.hibernate.annotations.common.reflection.XAnnotatedElement property)

getOverridableAnnotation

public static <T extends Annotation> T getOverridableAnnotation(org.hibernate.annotations.common.reflection.XAnnotatedElement element,
                                                                Class<T> annotationType,
                                                                MetadataBuildingContext context)