HHH-6173 Some initial refactorings to start processing @Embedded and @embeddable

Author: hferentschik

hibernate-core/src/main/java/org/hibernate/metamodel/domain/Attribute.java

@@ -24,7 +24,7 @@
 package org.hibernate.metamodel.domain;
 
 /**
- * Desribes an attribute.
+ * Describes an attribute.
  *
  * @author Steve Ebersole
  */

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/AnnotationBinder.java

@@ -120,7 +120,6 @@ private ClassLoaderService classLoaderService(){
 		return classLoaderService;
 	}
 
-
 	@Override
 	public void bindIndependentMetadata(MetadataSources sources) {
         TypeDefBinder.bind( metadata, index );

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/AnnotationBindingContext.java

@@ -0,0 +1,56 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2011, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.metamodel.source.annotations.entity;
+
+
+import org.jboss.jandex.Index;
+
+import org.hibernate.service.ServiceRegistry;
+import org.hibernate.service.classloading.spi.ClassLoaderService;
+
+/**
+ * Helper class for keeping some context information needed during the processing of mapped classes.
+ *
+ * @author Hardy Ferentschik
+ */
+public class AnnotationBindingContext {
+	private final ServiceRegistry serviceRegistry;
+	private final Index index;
+
+	private ClassLoaderService classLoaderService;
+
+	public AnnotationBindingContext(Index index, ServiceRegistry serviceRegistry) {
+		this.index = index;
+		this.serviceRegistry = serviceRegistry;
+	}
+
+	public ClassLoaderService classLoaderService() {
+		if ( classLoaderService == null ) {
+			classLoaderService = serviceRegistry.getService( ClassLoaderService.class );
+		}
+		return classLoaderService;
+	}
+}
+
+

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/AssociationAttribute.java

@@ -41,16 +41,16 @@
  * @author Hardy Ferentschik
  */
 public class AssociationAttribute extends SimpleAttribute {
-	private final AssociationType associationType;
+	private final AttributeType associationType;
 	private final boolean ignoreNotFound;
 	private final String referencedEntityType;
 	private final Set<CascadeType> cascadeTypes;
 
-	public static AssociationAttribute createAssociationAttribute(String name, String type, AssociationType associationType, Map<DotName, List<AnnotationInstance>> annotations) {
+	public static AssociationAttribute createAssociationAttribute(String name, String type, AttributeType associationType, Map<DotName, List<AnnotationInstance>> annotations) {
 		return new AssociationAttribute( name, type, associationType, annotations );
 	}
 
-	private AssociationAttribute(String name, String type, AssociationType associationType, Map<DotName, List<AnnotationInstance>> annotations) {
+	private AssociationAttribute(String name, String type, AttributeType associationType, Map<DotName, List<AnnotationInstance>> annotations) {
 		super( name, type, annotations, false );
 		this.associationType = associationType;
 		this.ignoreNotFound = ignoreNotFound();
@@ -72,7 +72,7 @@ public String getReferencedEntityType() {
 		return referencedEntityType;
 	}
 
-	public AssociationType getAssociationType() {
+	public AttributeType getAssociationType() {
 		return associationType;
 	}
 

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/AssociationType.java renamed to hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/AttributeType.java

@@ -28,18 +28,21 @@
 import org.hibernate.metamodel.source.annotations.JPADotNames;
 
 /**
+ * An enum defining the type of mapped attribute.
+ *
  * @author Hardy Ferentschik
  */
-public enum AssociationType {
-	NO_ASSOCIATION( null ),
+public enum AttributeType {
+	BASIC( null ),
 	ONE_TO_ONE( JPADotNames.ONE_TO_ONE ),
 	ONE_TO_MANY( JPADotNames.ONE_TO_MANY ),
 	MANY_TO_ONE( JPADotNames.MANY_TO_ONE ),
-	MANY_TO_MANY( JPADotNames.MANY_TO_MANY );
+	MANY_TO_MANY( JPADotNames.MANY_TO_MANY ),
+	EMBEDDED( JPADotNames.EMBEDDED );
 
 	private final DotName annotationDotName;
 
-	AssociationType(DotName annotationDotName) {
+	AttributeType(DotName annotationDotName) {
 		this.annotationDotName = annotationDotName;
 	}
 

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/ConfiguredClass.java

@@ -29,6 +29,7 @@
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.EnumMap;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -55,8 +56,6 @@
 import org.hibernate.metamodel.source.annotations.JPADotNames;
 import org.hibernate.metamodel.source.annotations.util.JandexHelper;
 import org.hibernate.metamodel.source.annotations.util.ReflectionHelper;
-import org.hibernate.service.ServiceRegistry;
-import org.hibernate.service.classloading.spi.ClassLoaderService;
 
 /**
  * Represents an entity, mapped superclass or component configured via annotations/xml.
@@ -68,7 +67,15 @@ public class ConfiguredClass {
 	 * The parent of this configured class or {@code null} in case this configured class is the root of a hierarchy.
 	 */
 	private final ConfiguredClass parent;
+
+	/**
+	 * The Jandex class info for this configured class. Provides access to the annotation defined on this configured class.
+	 */
 	private final ClassInfo classInfo;
+
+	/**
+	 * The actual java type.
+	 */
 	private final Class<?> clazz;
 
 	private final boolean isRoot;
@@ -83,19 +90,24 @@ public class ConfiguredClass {
 	private final IdType idType;
 
 	private final Map<String, MappedAttribute> mappedAttributes;
+	private final Set<String> transientFieldNames = new HashSet<String>();
+	private final Set<String> transientMethodNames = new HashSet<String>();
+
+	private final AnnotationBindingContext context;
 
 	public ConfiguredClass(ClassInfo info,
 						   ConfiguredClass parent,
 						   AccessType hierarchyAccessType,
 						   InheritanceType inheritanceType,
-						   ServiceRegistry serviceRegistry,
-						   ResolvedTypeWithMembers resolvedType) {
+						   ResolvedTypeWithMembers resolvedType,
+						   AnnotationBindingContext context) {
+		this.context = context;
 		this.classInfo = info;
 		this.parent = parent;
 		this.isRoot = parent == null;
 		this.hierarchyAccessType = hierarchyAccessType;
 		this.inheritanceType = inheritanceType;
-		this.clazz = serviceRegistry.getService( ClassLoaderService.class ).classForName( info.toString() );
+		this.clazz = context.classLoaderService().classForName( info.toString() );
 
 		this.configuredClassType = determineType();
 		this.classAccessType = determineClassAccessType();
@@ -104,6 +116,9 @@ public ConfiguredClass(ClassInfo info,
 		this.hasOwnTable = definesItsOwnTable();
 		this.primaryTableName = determinePrimaryTableName();
 
+		// find transient field and method names
+		findTransientFieldAndMethodNames();
+
 		List<MappedAttribute> simpleProps = collectAttributes( resolvedType );
 		// make sure the properties are ordered by property name
 		Collections.sort( simpleProps );
@@ -213,11 +228,6 @@ private AccessType determineClassAccessType() {
 	 * @return A list of the persistent properties of this configured class
 	 */
 	private List<MappedAttribute> collectAttributes(ResolvedTypeWithMembers resolvedTypes) {
-		// create sets of transient field and method names
-		Set<String> transientFieldNames = new HashSet<String>();
-		Set<String> transientMethodNames = new HashSet<String>();
-		populateTransientFieldAndMethodLists( transientFieldNames, transientMethodNames );
-
 		// use the class mate library to generic types
 		ResolvedTypeWithMembers resolvedType = null;
 		for ( HierarchicType hierarchicType : resolvedTypes.allTypesAndOverrides() ) {
@@ -381,42 +391,67 @@ private MappedAttribute createMappedProperty(Member member, ResolvedTypeWithMemb
 		);
 
 		MappedAttribute attribute;
-		AssociationType associationType = determineAssociationType( annotations );
-		switch ( associationType ) {
-			case NO_ASSOCIATION: {
+		AttributeType attributeType = determineAttributeType( annotations );
+		switch ( attributeType ) {
+			case BASIC: {
 				attribute = SimpleAttribute.createSimpleAttribute( name, ( (Class) type ).getName(), annotations );
 				break;
 			}
+			case EMBEDDED: {
+				throw new HibernateException( "foo" );
+			}
+			// TODO handle the different association types
 			default: {
 				attribute = AssociationAttribute.createAssociationAttribute(
-						name, ( (Class) type ).getName(), associationType, annotations
+						name, ( (Class) type ).getName(), attributeType, annotations
 				);
 			}
 		}
 
 		return attribute;
 	}
 
-	private AssociationType determineAssociationType(Map<DotName, List<AnnotationInstance>> annotations) {
+	/**
+	 * Given the annotations defined on a persistent attribute this methods determines the attribute type.
+	 *
+	 * @param annotations the annotations defined on the persistent attribute
+	 *
+	 * @return an instance of the {@code AttributeType} enum
+	 */
+	private AttributeType determineAttributeType(Map<DotName, List<AnnotationInstance>> annotations) {
+		EnumMap<AttributeType, AnnotationInstance> discoveredAttributeTypes =
+				new EnumMap<AttributeType, AnnotationInstance>( AttributeType.class );
+
 		AnnotationInstance oneToOne = JandexHelper.getSingleAnnotation( annotations, JPADotNames.ONE_TO_ONE );
+		if ( oneToOne != null ) {
+			discoveredAttributeTypes.put( AttributeType.ONE_TO_ONE, oneToOne );
+		}
+
 		AnnotationInstance oneToMany = JandexHelper.getSingleAnnotation( annotations, JPADotNames.ONE_TO_MANY );
-		AnnotationInstance manyToOne = JandexHelper.getSingleAnnotation( annotations, JPADotNames.MANY_TO_ONE );
-		AnnotationInstance manyToMany = JandexHelper.getSingleAnnotation( annotations, JPADotNames.MANY_TO_MANY );
+		if ( oneToMany != null ) {
+			discoveredAttributeTypes.put( AttributeType.ONE_TO_MANY, oneToMany );
+		}
 
-		if ( oneToOne == null && oneToMany == null && manyToOne == null && manyToMany == null ) {
-			return AssociationType.NO_ASSOCIATION;
+		AnnotationInstance manyToOne = JandexHelper.getSingleAnnotation( annotations, JPADotNames.MANY_TO_ONE );
+		if ( manyToOne != null ) {
+			discoveredAttributeTypes.put( AttributeType.MANY_TO_ONE, manyToOne );
 		}
-		else if ( oneToOne != null && oneToMany == null && manyToOne == null && manyToMany == null ) {
-			return AssociationType.ONE_TO_ONE;
+
+		AnnotationInstance manyToMany = JandexHelper.getSingleAnnotation( annotations, JPADotNames.MANY_TO_MANY );
+		if ( manyToMany != null ) {
+			discoveredAttributeTypes.put( AttributeType.MANY_TO_MANY, manyToMany );
 		}
-		else if ( oneToOne == null && oneToMany != null && manyToOne == null && manyToMany == null ) {
-			return AssociationType.ONE_TO_MANY;
+
+		AnnotationInstance embedded = JandexHelper.getSingleAnnotation( annotations, JPADotNames.EMBEDDED );
+		if ( embedded != null ) {
+			discoveredAttributeTypes.put( AttributeType.EMBEDDED, embedded );
 		}
-		else if ( oneToOne == null && oneToMany == null && manyToOne != null && manyToMany == null ) {
-			return AssociationType.MANY_TO_ONE;
+
+		if ( discoveredAttributeTypes.size() == 0 ) {
+			return AttributeType.BASIC;
 		}
-		else if ( oneToOne == null && oneToMany == null && manyToOne == null && manyToMany != null ) {
-			return AssociationType.MANY_TO_MANY;
+		else if ( discoveredAttributeTypes.size() == 1 ) {
+			return discoveredAttributeTypes.keySet().iterator().next();
 		}
 		else {
 			throw new AnnotationException( "More than one association type configured for property  " + getName() + " of class " + getName() );
@@ -435,11 +470,8 @@ private Type findResolvedType(String name, ResolvedMember[] resolvedMembers) {
 
 	/**
 	 * Populates the sets of transient field and method names.
-	 *
-	 * @param transientFieldNames Set to populate with the field names explicitly marked as @Transient
-	 * @param transientMethodNames set to populate with the method names explicitly marked as @Transient
 	 */
-	private void populateTransientFieldAndMethodLists(Set<String> transientFieldNames, Set<String> transientMethodNames) {
+	private void findTransientFieldAndMethodNames() {
 		List<AnnotationInstance> transientMembers = classInfo.annotations().get( JPADotNames.TRANSIENT );
 		if ( transientMembers == null ) {
 			return;
@@ -524,5 +556,3 @@ private IdType determineIdType() {
 		return IdType.NONE;
 	}
 }
-
-

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/ConfiguredClassHierarchy.java

@@ -39,11 +39,10 @@
 import org.hibernate.metamodel.source.annotations.JPADotNames;
 import org.hibernate.metamodel.source.annotations.util.JandexHelper;
 import org.hibernate.metamodel.source.annotations.util.ReflectionHelper;
-import org.hibernate.service.ServiceRegistry;
 import org.hibernate.service.classloading.spi.ClassLoaderService;
 
 /**
- * Represents the inheritance structure of the configured classes within a class hierarchy.
+ * Contains information about the access and inheritance type for all classes within a class hierarchy.
  *
  * @author Hardy Ferentschik
  */
@@ -52,23 +51,23 @@ public class ConfiguredClassHierarchy implements Iterable<ConfiguredClass> {
 	private final InheritanceType inheritanceType;
 	private final List<ConfiguredClass> configuredClasses;
 
-	public static ConfiguredClassHierarchy create(List<ClassInfo> classes, ServiceRegistry serviceRegistry) {
-		return new ConfiguredClassHierarchy( classes, serviceRegistry );
+	public static ConfiguredClassHierarchy create(List<ClassInfo> classes, AnnotationBindingContext context) {
+		return new ConfiguredClassHierarchy( classes, context );
 	}
 
-	private ConfiguredClassHierarchy(List<ClassInfo> classes, ServiceRegistry serviceRegistry) {
+	private ConfiguredClassHierarchy(List<ClassInfo> classes, AnnotationBindingContext context) {
 		defaultAccessType = determineDefaultAccessType( classes );
 		inheritanceType = determineInheritanceType( classes );
 
-		ClassLoaderService classLoaderService = serviceRegistry.getService( ClassLoaderService.class );
-		Class<?> clazz = classLoaderService.classForName( classes.get( classes.size() - 1 ).name().toString() );
-		ResolvedTypeWithMembers resolvedMembers = ReflectionHelper.resolveMemberTypes( clazz );
+		// the resolved type for the top level class in the hierarchy
+		Class<?> clazz = context.classLoaderService().classForName( classes.get( classes.size() - 1 ).name().toString() );
+		ResolvedTypeWithMembers resolvedType = ReflectionHelper.resolveMemberTypes( clazz );
 
 		configuredClasses = new ArrayList<ConfiguredClass>();
 		ConfiguredClass parent = null;
 		for ( ClassInfo info : classes ) {
 			ConfiguredClass configuredClass = new ConfiguredClass(
-					info, parent, defaultAccessType, inheritanceType, serviceRegistry, resolvedMembers
+					info, parent, defaultAccessType, inheritanceType, resolvedType, context
 			);
 			configuredClasses.add( configuredClass );
 			parent = configuredClass;
@@ -114,7 +113,7 @@ private AccessType determineDefaultAccessType(List<ClassInfo> classes) {
 			if ( idAnnotations == null || idAnnotations.size() == 0 ) {
 				continue;
 			}
-			accessType = processIdAnnotations( idAnnotations );
+			accessType = determineAccessTypeByIdPlacement( idAnnotations );
 		}
 
 		if ( accessType == null ) {
@@ -124,7 +123,7 @@ private AccessType determineDefaultAccessType(List<ClassInfo> classes) {
 		return accessType;
 	}
 
-	private AccessType processIdAnnotations(List<AnnotationInstance> idAnnotations) {
+	private AccessType determineAccessTypeByIdPlacement(List<AnnotationInstance> idAnnotations) {
 		AccessType accessType = null;
 		for ( AnnotationInstance annotation : idAnnotations ) {
 			AccessType tmpAccessType;
@@ -217,5 +216,3 @@ private String hierarchyListString(List<ClassInfo> classes) {
 		return builder.toString();
 	}
 }
-
-

hibernate-core/src/main/java/org/hibernate/metamodel/source/annotations/entity/MappedAttribute.java

@@ -39,7 +39,7 @@
  *
  * @author Hardy Ferentschik
  */
-public class MappedAttribute implements Comparable<MappedAttribute> {
+public abstract class MappedAttribute implements Comparable<MappedAttribute> {
 	/**
 	 * Annotations defined on the attribute, keyed against the annotation dot name.
 	 */