Package org.hibernate.cfg

Class AnnotationBinder

java.lang.Object

org.hibernate.cfg.AnnotationBinder

public final class AnnotationBinder
extends Object

JSR 175 annotation binder which reads the annotations from classes, applies the principles of the EJB3 spec and produces the Hibernate configuration-time metamodel (the classes in the org.hibernate.mapping package)

Some design description I tried to remove any link to annotation except from the 2 first level of method call. It'll enable to: - facilitate annotation overriding - mutualize one day xml and annotation binder (probably a dream though) - split this huge class in smaller mapping oriented classes bindSomething usually create the mapping container and is accessed by one of the 2 first level method makeSomething usually create the mapping container and is accessed by bindSomething[else] fillSomething take the container into parameter and fill it.

Method Summary

Modifier and Type	Method	Description
static void	bindClass(org.hibernate.annotations.common.reflection.XClass clazzToProcess, Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass, MetadataBuildingContext context)	Bind a class having JSR175 annotations.
static void	bindDefaults(MetadataBuildingContext context)
static void	bindFetchProfilesForClass(org.hibernate.annotations.common.reflection.XClass clazzToProcess, MetadataBuildingContext context)
static void	bindFetchProfilesForPackage(ClassLoaderService cls, String packageName, MetadataBuildingContext context)
static void	bindFilterDefs(org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement, MetadataBuildingContext context)
static void	bindForeignKeyNameAndDefinition(SimpleValue value, org.hibernate.annotations.common.reflection.XProperty property, jakarta.persistence.ForeignKey fkOverride, jakarta.persistence.JoinColumn joinColumn, jakarta.persistence.JoinColumns joinColumns, MetadataBuildingContext context)
static void	bindPackage(ClassLoaderService cls, String packageName, MetadataBuildingContext context)
static void	bindQueries(org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement, MetadataBuildingContext context)
static HashMap<String,IdentifierGeneratorDefinition>	buildGenerators(org.hibernate.annotations.common.reflection.XAnnotatedElement annElt, MetadataBuildingContext context)
static Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState>	buildInheritanceStates(List<org.hibernate.annotations.common.reflection.XClass> orderedClasses, MetadataBuildingContext buildingContext)	For the mapped entities build some temporary data-structure containing information about the inheritance status of a class.
static Component	createComponent(PropertyHolder propertyHolder, PropertyData inferredData, boolean isComponentEmbedded, boolean isIdentifierMapper, Class<? extends EmbeddableInstantiator> customInstantiatorImpl, MetadataBuildingContext context)
static Component	fillComponent(PropertyHolder propertyHolder, PropertyData inferredData, AccessType propertyAccessor, boolean isNullable, EntityBinder entityBinder, boolean isComponentEmbedded, boolean isIdentifierMapper, boolean inSecondPass, Class<? extends EmbeddableInstantiator> customInstantiatorImpl, Class<? extends CompositeUserType<?>> compositeUserTypeClass, MetadataBuildingContext buildingContext, Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)
static Component	fillComponent(PropertyHolder propertyHolder, PropertyData inferredData, PropertyData baseInferredData, AccessType propertyAccessor, boolean isNullable, EntityBinder entityBinder, boolean isComponentEmbedded, boolean isIdentifierMapper, boolean inSecondPass, Class<? extends EmbeddableInstantiator> customInstantiatorImpl, Class<? extends CompositeUserType<?>> compositeUserTypeClass, MetadataBuildingContext buildingContext, Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)
static String	generatorType(jakarta.persistence.GeneratedValue generatedValueAnn, MetadataBuildingContext buildingContext, org.hibernate.annotations.common.reflection.XClass javaTypeXClass)
static String	getCascadeStrategy(jakarta.persistence.CascadeType[] ejbCascades, Cascade hibernateCascadeAnnotation, boolean orphanRemoval, boolean forcePersist)
static FetchMode	getFetchMode(jakarta.persistence.FetchType fetch)
static PropertyData	getUniqueIdPropertyFromBaseClass(PropertyData inferredData, PropertyData baseInferredData, AccessType propertyAccessor, MetadataBuildingContext context)
static boolean	isDefault(org.hibernate.annotations.common.reflection.XClass clazz, MetadataBuildingContext context)
static void	processElementAnnotations(PropertyHolder propertyHolder, Nullability nullability, PropertyData inferredData, HashMap<String,IdentifierGeneratorDefinition> classGenerators, EntityBinder entityBinder, boolean isIdentifierMapper, boolean isComponentEmbedded, boolean inSecondPass, MetadataBuildingContext context, Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)

Methods inherited from class java.lang.Object

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

Method Detail

bindDefaults

public static void bindDefaults(MetadataBuildingContext context)

bindPackage

public static void bindPackage(ClassLoaderService cls,
                               String packageName,
                               MetadataBuildingContext context)

bindQueries

public static void bindQueries(org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement,
                               MetadataBuildingContext context)

bindClass

public static void bindClass(org.hibernate.annotations.common.reflection.XClass clazzToProcess,
                             Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass,
                             MetadataBuildingContext context)
                      throws MappingException

Bind a class having JSR175 annotations. Subclasses have to be bound after its parent class.

Parameters:

clazzToProcess - entity to bind as XClass instance

inheritanceStatePerClass - Metadata about the inheritance relationships for all mapped classes

Throws:

MappingException - in case there is a configuration error

bindFilterDefs

public static void bindFilterDefs(org.hibernate.annotations.common.reflection.XAnnotatedElement annotatedElement,
                                  MetadataBuildingContext context)

bindFetchProfilesForClass

public static void bindFetchProfilesForClass(org.hibernate.annotations.common.reflection.XClass clazzToProcess,
                                             MetadataBuildingContext context)

bindFetchProfilesForPackage

public static void bindFetchProfilesForPackage(ClassLoaderService cls,
                                               String packageName,
                                               MetadataBuildingContext context)

processElementAnnotations

public static void processElementAnnotations(PropertyHolder propertyHolder,
                                             Nullability nullability,
                                             PropertyData inferredData,
                                             HashMap<String,IdentifierGeneratorDefinition> classGenerators,
                                             EntityBinder entityBinder,
                                             boolean isIdentifierMapper,
                                             boolean isComponentEmbedded,
                                             boolean inSecondPass,
                                             MetadataBuildingContext context,
                                             Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)
                                      throws MappingException

Throws:

MappingException

generatorType

public static String generatorType(jakarta.persistence.GeneratedValue generatedValueAnn,
                                   MetadataBuildingContext buildingContext,
                                   org.hibernate.annotations.common.reflection.XClass javaTypeXClass)

fillComponent

public static Component fillComponent(PropertyHolder propertyHolder,
                                      PropertyData inferredData,
                                      AccessType propertyAccessor,
                                      boolean isNullable,
                                      EntityBinder entityBinder,
                                      boolean isComponentEmbedded,
                                      boolean isIdentifierMapper,
                                      boolean inSecondPass,
                                      Class<? extends EmbeddableInstantiator> customInstantiatorImpl,
                                      Class<? extends CompositeUserType<?>> compositeUserTypeClass,
                                      MetadataBuildingContext buildingContext,
                                      Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)

fillComponent

public static Component fillComponent(PropertyHolder propertyHolder,
                                      PropertyData inferredData,
                                      PropertyData baseInferredData,
                                      AccessType propertyAccessor,
                                      boolean isNullable,
                                      EntityBinder entityBinder,
                                      boolean isComponentEmbedded,
                                      boolean isIdentifierMapper,
                                      boolean inSecondPass,
                                      Class<? extends EmbeddableInstantiator> customInstantiatorImpl,
                                      Class<? extends CompositeUserType<?>> compositeUserTypeClass,
                                      MetadataBuildingContext buildingContext,
                                      Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> inheritanceStatePerClass)

createComponent

public static Component createComponent(PropertyHolder propertyHolder,
                                        PropertyData inferredData,
                                        boolean isComponentEmbedded,
                                        boolean isIdentifierMapper,
                                        Class<? extends EmbeddableInstantiator> customInstantiatorImpl,
                                        MetadataBuildingContext context)

getUniqueIdPropertyFromBaseClass

public static PropertyData getUniqueIdPropertyFromBaseClass(PropertyData inferredData,
                                                            PropertyData baseInferredData,
                                                            AccessType propertyAccessor,
                                                            MetadataBuildingContext context)

getCascadeStrategy

public static String getCascadeStrategy(jakarta.persistence.CascadeType[] ejbCascades,
                                        Cascade hibernateCascadeAnnotation,
                                        boolean orphanRemoval,
                                        boolean forcePersist)

getFetchMode

public static FetchMode getFetchMode(jakarta.persistence.FetchType fetch)

bindForeignKeyNameAndDefinition

public static void bindForeignKeyNameAndDefinition(SimpleValue value,
                                                   org.hibernate.annotations.common.reflection.XProperty property,
                                                   jakarta.persistence.ForeignKey fkOverride,
                                                   jakarta.persistence.JoinColumn joinColumn,
                                                   jakarta.persistence.JoinColumns joinColumns,
                                                   MetadataBuildingContext context)

buildGenerators

public static HashMap<String,IdentifierGeneratorDefinition> buildGenerators(org.hibernate.annotations.common.reflection.XAnnotatedElement annElt,
                                                                                  MetadataBuildingContext context)

isDefault

public static boolean isDefault(org.hibernate.annotations.common.reflection.XClass clazz,
                                MetadataBuildingContext context)

buildInheritanceStates

public static Map<org.hibernate.annotations.common.reflection.XClass,InheritanceState> buildInheritanceStates(List<org.hibernate.annotations.common.reflection.XClass> orderedClasses,
                                                                                                                    MetadataBuildingContext buildingContext)

For the mapped entities build some temporary data-structure containing information about the inheritance status of a class.

Parameters:

orderedClasses - Order list of all annotated entities and their mapped superclasses

Returns:

A map of InheritanceStates keyed against their XClass.