HHH-4396 - Ability to patternize embedded column names

Author: sebersole

hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedColumn.java

@@ -351,38 +351,38 @@ public void redefineColumnName(String columnName, String propertyName, boolean a
 				final String inferredColumnName = inferColumnName( propertyName );
 				String realColumnName = inferredColumnName;
 				if ( parent.getPropertyHolder().isComponent() ) {
-					// find the pattern if there is one, e.g. `home_%s`
-					final String columnNamingPattern = findColumnNamingPattern( (ComponentPropertyHolder) parent.getPropertyHolder() );
-					if ( columnNamingPattern != null ) {
-						// apply the pattern - `home_city`
-						realColumnName = String.format( columnNamingPattern, inferredColumnName );
-						// we need to adjust the logical name to be picked up in `#addColumnBinding`
-						logicalColumnName = realColumnName;
-					}
+					realColumnName = applyEmbeddedColumnNaming( realColumnName, (ComponentPropertyHolder) parent.getPropertyHolder() );
+					// we need to adjust the logical name to be picked up in `#addColumnBinding`
+					logicalColumnName = realColumnName;
 				}
 				mappingColumn.setName( realColumnName );
 			}
 			//Do nothing otherwise
 		}
 	}
 
-	private String findColumnNamingPattern(ComponentPropertyHolder propertyHolder) {
+	private String applyEmbeddedColumnNaming(String inferredColumnName, ComponentPropertyHolder propertyHolder) {
+		// code
+		String result = inferredColumnName;
+
 		final String columnNamingPattern = propertyHolder.getComponent().getColumnNamingPattern();
 		if ( StringHelper.isNotEmpty( columnNamingPattern ) ) {
-			return columnNamingPattern;
+			// zip_code
+			result = String.format( columnNamingPattern, result );
 		}
 
 		ComponentPropertyHolder tester = propertyHolder;
 		while ( tester.parent.isComponent() ) {
 			final ComponentPropertyHolder parentHolder = (ComponentPropertyHolder) tester.parent;
 			final String parentColumnNamingPattern = parentHolder.getComponent().getColumnNamingPattern();
 			if ( StringHelper.isNotEmpty( parentColumnNamingPattern ) ) {
-				return parentColumnNamingPattern;
+				// 	home_zip_code
+				result = String.format( parentColumnNamingPattern, result );
 			}
 			tester = parentHolder;
 		}
 
-		return null;
+		return result;
 	}
 
 	private String processColumnName(String columnName, boolean applyNamingStrategy) {

hibernate-core/src/main/java/org/hibernate/boot/model/internal/EmbeddableBinder.java

@@ -998,13 +998,11 @@ static Component createEmbeddable(
 			final ComponentPropertyHolder componentPropertyHolder = (ComponentPropertyHolder) propertyHolder;
 			component.setParentAggregateColumn( componentPropertyHolder.getAggregateColumn() );
 		}
-		else {
-			applyColumnNamingPattern( component, propertyHolder, inferredData, context );
-		}
+		applyColumnNamingPattern( component, inferredData );
 		return component;
 	}
 
-	private static void applyColumnNamingPattern(Component component, PropertyHolder propertyHolder, PropertyData inferredData, MetadataBuildingContext context) {
+	private static void applyColumnNamingPattern(Component component, PropertyData inferredData) {
 		final Class<?> componentClass = component.getComponentClass();
 		if ( componentClass == null || Map.class.equals( componentClass ) ) {
 			// dynamic models

hibernate-core/src/test/java/org/hibernate/orm/test/naming/EmbeddedColumnNamingTests.java

@@ -71,7 +71,7 @@ void testBaselineNamingPattern(SessionFactoryScope sfScope) {
 		verifyColumnNames( persister.findAttributeMapping( "homeAddress" ), "home_" );
 	}
 
-	private void verifyColumnNames(AttributeMapping embeddedMapping, String prefix) {
+	public static void verifyColumnNames(AttributeMapping embeddedMapping, String prefix) {
 		embeddedMapping.forEachSelectable( (selectionIndex, selectableMapping) -> {
 			assertThat( selectableMapping.getSelectionExpression() ).startsWith( prefix );
 		} );

hibernate-core/src/test/java/org/hibernate/orm/test/naming/NestedEmbeddableNamingTests.java

@@ -0,0 +1,85 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.orm.test.naming;
+
+import jakarta.persistence.Embeddable;
+import jakarta.persistence.Embedded;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import org.hibernate.annotations.EmbeddedColumnNaming;
+import org.hibernate.engine.spi.SessionFactoryImplementor;
+import org.hibernate.metamodel.mapping.internal.EmbeddedAttributeMapping;
+import org.hibernate.metamodel.spi.MappingMetamodelImplementor;
+import org.hibernate.persister.entity.EntityPersister;
+import org.hibernate.testing.orm.junit.DomainModel;
+import org.hibernate.testing.orm.junit.ServiceRegistry;
+import org.hibernate.testing.orm.junit.SessionFactory;
+import org.hibernate.testing.orm.junit.SessionFactoryScope;
+import org.junit.jupiter.api.Test;
+
+import static org.hibernate.orm.test.naming.EmbeddedColumnNamingTests.verifyColumnNames;
+
+/**
+ * @author Steve Ebersole
+ */
+@SuppressWarnings("JUnitMalformedDeclaration")
+public class NestedEmbeddableNamingTests {
+
+	/**
+	 * Test use of {@code @EmbeddedColumnNaming} one 2 separate embedded attributes
+	 */
+	@Test
+	@ServiceRegistry
+	@DomainModel(annotatedClasses = {Address.class, Person.class})
+	@SessionFactory
+	void testNestedNamingPattern(SessionFactoryScope sfScope) {
+		final SessionFactoryImplementor sessionFactory = sfScope.getSessionFactory();
+		final MappingMetamodelImplementor mappingMetamodel = sessionFactory.getMappingMetamodel();
+		final EntityPersister persister = mappingMetamodel.getEntityDescriptor( Person.class );
+
+		final EmbeddedAttributeMapping homeAddressMapping = (EmbeddedAttributeMapping) persister.findAttributeMapping( "homeAddress" );
+		verifyColumnNames( homeAddressMapping, "home_" );
+		final EmbeddedAttributeMapping homeZipMapping = (EmbeddedAttributeMapping) homeAddressMapping.getEmbeddableTypeDescriptor().findAttributeMapping( "zip" );
+		verifyColumnNames( homeZipMapping, "home_zip" );
+
+		final EmbeddedAttributeMapping workAddressMapping = (EmbeddedAttributeMapping) persister.findAttributeMapping( "workAddress" );
+		verifyColumnNames( workAddressMapping, "work_" );
+		final EmbeddedAttributeMapping workZipMapping = (EmbeddedAttributeMapping) workAddressMapping.getEmbeddableTypeDescriptor().findAttributeMapping( "zip" );
+		verifyColumnNames( workZipMapping, "work_zip" );
+	}
+
+	@Entity(name="Person")
+	@Table(name="person")
+	public static class Person {
+		@Id
+		private Integer id;
+		private String name;
+
+		@Embedded
+		@EmbeddedColumnNaming("home_%s")
+		private Address homeAddress;
+
+		@Embedded
+		@EmbeddedColumnNaming("work_%s")
+		private Address workAddress;
+	}
+
+	@Embeddable
+	public static class Address {
+		private String street;
+		private String city;
+		private String state;
+		@Embedded
+		@EmbeddedColumnNaming( "zip_%s" )
+		private ZipPlus zip;
+	}
+
+	@Embeddable
+	public static class ZipPlus {
+		private String code;
+		private String plus4;
+	}
+}