HHH-6480 - Develop component binding for new metamodel

Author: sebersole

hibernate-core/src/main/java/org/hibernate/metamodel/binding/AbstractAttributeBindingContainer.java

@@ -26,36 +26,101 @@
 import org.hibernate.metamodel.domain.AttributeContainer;
 import org.hibernate.metamodel.domain.PluralAttribute;
 import org.hibernate.metamodel.domain.SingularAttribute;
-import org.hibernate.metamodel.relational.TableSpecification;
 import org.hibernate.metamodel.source.MetaAttributeContext;
 
 /**
+ * Common contract for {@link EntityBinding} and {@link ComponentAttributeBinding} in so far as they are both
+ * containers for {@link AttributeBinding} descriptors
+ *
  * @author Steve Ebersole
  */
 public interface AttributeBindingContainer {
+	/**
+	 * Obtain the path base of this container.  Intended to help uniquely identify each attribute binding.
+	 *
+	 * @return The path base for this container.
+	 */
 	public String getPathBase();
 
+	/**
+	 * Obtain the underlying domain attribute container.
+	 *
+	 * @return The attribute container
+	 */
 	public AttributeContainer getAttributeContainer();
 
+	/**
+	 * Obtain all attribute bindings
+	 *
+	 * @return All attribute bindings
+	 */
 	public Iterable<AttributeBinding> attributeBindings();
 
+	/**
+	 * Locate a specific attribute binding, by its local name.
+	 *
+	 * @param name The name of the attribute, local to this container.
+	 *
+	 * @return The attribute binding.
+	 */
 	public AttributeBinding locateAttributeBinding(String name);
 
-	public SimpleSingularAttributeBinding makeSimpleAttributeBinding(SingularAttribute attribute);
+	/**
+	 * Factory method for basic attribute bindings.
+	 *
+	 * @param attribute The attribute for which to make a binding.
+	 *
+	 * @return The attribute binding instance.
+	 */
+	public BasicAttributeBinding makeBasicAttributeBinding(SingularAttribute attribute);
 
+	/**
+	 * Factory method for component attribute bindings.
+	 *
+	 * @param attribute The attribute for which to make a binding.
+	 *
+	 * @return The attribute binding instance.
+	 */
 	public ComponentAttributeBinding makeComponentAttributeBinding(SingularAttribute attribute);
 
+	/**
+	 * Factory method for many-to-one attribute bindings.
+	 *
+	 * @param attribute The attribute for which to make a binding.
+	 *
+	 * @return The attribute binding instance.
+	 */
 	public ManyToOneAttributeBinding makeManyToOneAttributeBinding(SingularAttribute attribute);
 
+	/**
+	 * Factory method for bag attribute bindings.
+	 *
+	 * @param attribute The attribute for which to make a binding.
+	 * @param nature The nature of the collection elements.
+	 *
+	 * @return The attribute binding instance.
+	 */
 	public BagBinding makeBagAttributeBinding(PluralAttribute attribute, CollectionElementNature nature);
 
+	/**
+	 * Seeks out the entity binding that is the root of this component path.
+	 *
+	 * @return The entity binding
+	 */
 	public EntityBinding seekEntityBinding();
 
-	public TableSpecification getPrimaryTable();
-
-	public TableSpecification locateTable(String containingTableName);
-
+	/**
+	 * Obtain the {@link Class} reference for this attribute container.  Generally this is used to perform reflection
+	 * on the attributes.
+	 *
+	 * @return The {@link Class} reference
+	 */
 	public Class<?> getClassReference();
 
+	/**
+	 * Obtain the meta-attribute context for this container.
+	 *
+	 * @return The meta-attribute context.
+	 */
 	public MetaAttributeContext getMetaAttributeContext();
 }

hibernate-core/src/main/java/org/hibernate/metamodel/binding/AttributeBindingContainer.java

@@ -41,7 +41,7 @@
  *
  * @author Steve Ebersole
  */
-public class SimpleSingularAttributeBinding
+public class BasicAttributeBinding
 		extends AbstractSingularAttributeBinding
 		implements SingularAttributeBinding, KeyValueBinding {
 
@@ -55,7 +55,7 @@ public class SimpleSingularAttributeBinding
 
 	private MetaAttributeContext metaAttributeContext;
 
-	SimpleSingularAttributeBinding(
+	BasicAttributeBinding(
 			AttributeBindingContainer container,
 			SingularAttribute attribute,
 			boolean forceNonNullable,

hibernate-core/src/main/java/org/hibernate/metamodel/binding/SimpleSingularAttributeBinding.java renamed to hibernate-core/src/main/java/org/hibernate/metamodel/binding/BasicAttributeBinding.java

@@ -38,7 +38,7 @@ public class CollectionKey {
 	private HibernateTypeDescriptor hibernateTypeDescriptor;
 
 // todo : this would be nice to have but we do not always know it, especially in HBM case.
-//	private SimpleSingularAttributeBinding otherSide;
+//	private BasicAttributeBinding otherSide;
 
 	public CollectionKey(AbstractPluralAttributeBinding collection) {
 		this.collection = collection;

hibernate-core/src/main/java/org/hibernate/metamodel/binding/CollectionKey.java

@@ -31,7 +31,6 @@
 import org.hibernate.metamodel.domain.Component;
 import org.hibernate.metamodel.domain.PluralAttribute;
 import org.hibernate.metamodel.domain.SingularAttribute;
-import org.hibernate.metamodel.relational.TableSpecification;
 import org.hibernate.metamodel.source.MetaAttributeContext;
 
 /**
@@ -83,16 +82,6 @@ public void setMetaAttributeContext(MetaAttributeContext metaAttributeContext) {
 		this.metaAttributeContext = metaAttributeContext;
 	}
 
-	@Override
-	public TableSpecification getPrimaryTable() {
-		return getContainer().getPrimaryTable();
-	}
-
-	@Override
-	public TableSpecification locateTable(String containingTableName) {
-		return getContainer().locateTable( containingTableName );
-	}
-
 	@Override
 	public AttributeBinding locateAttributeBinding(String name) {
 		return attributeBindingMap.get( name );
@@ -109,8 +98,8 @@ protected void checkValueBinding() {
 	}
 
 	@Override
-	public SimpleSingularAttributeBinding makeSimpleAttributeBinding(SingularAttribute attribute) {
-		final SimpleSingularAttributeBinding binding = new SimpleSingularAttributeBinding(
+	public BasicAttributeBinding makeBasicAttributeBinding(SingularAttribute attribute) {
+		final BasicAttributeBinding binding = new BasicAttributeBinding(
 				this,
 				attribute,
 				isNullable(),