HSEARCH-4317 Rename mapper-javabean to mapper-pojo-standalone (includ…

…ing packages/APIs)
hibernate · Jun 23, 2022 · ba200b7 · ba200b7
1 parent a55b44c
commit ba200b7
Show file tree

Hide file tree

Showing 209 changed files with 1,142 additions and 1,136 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -183,12 +183,12 @@ Here are some notable sub-directories:
 and transform it to use Jakarta EE instead of Java EE. 
 * `mapper`: The mappers, i.e. the modules that expose APIs to index and search user entities,
 and do the work of converting between user entities and documents to be indexed.
-  * `javabean`: An experimental (not published) mapper for Java Beans without Hibernate ORM.
-  Mostly useful for tests of the `pojo` module.
+  * `pojo-base`: Contains base classes and APIs that are re-used in other POJO-based mapper.
   * `orm`: A mapper for [Hibernate ORM](http://hibernate.org/orm/) entities.
   * `orm-coordination-outbox-polling`: An implementation of coordination of automatic indexing between nodes
   in the orm mapper (see above) using an outbox, i.e. an event table in the database. 
-  * `pojo-base`: Contains base classes and APIs that are re-used in other POJO-based mapper.
+  * `pojo-standalone`: An experimental (not published) mapper for POJOs in standalone mode, i.e. without Hibernate ORM.
+    Mostly useful for tests of the `pojo-base` module.
 * `orm6`: Modules that take the source code of other modules (e.g. mapper/orm)
 and transform it to use Hibernate ORM 6 instead of Hibernate ORM 5.x.
 * `reports`: Module built last, producing reports related to test coverage in particular.

diff --git a/documentation/src/main/asciidoc/internals/index.asciidoc b/documentation/src/main/asciidoc/internals/index.asciidoc
@@ -190,12 +190,12 @@ Also, the SPIs implemented by backends allow mappers to inject a "loading contex
 that will essentially transform document references into the entity that was initially indexed.
 
 [[pojo-base]]
-== [[_pojo_mapper]] POJO mapper
+== [[_pojo_mapper]] POJO mapper base
 
-What we call the POJO mapper is in fact an abstract basis for implementing mappers from Java objects to a full-text index.
+What we call the POJO mapper base (or POJO mapper for short) is an abstract base for implementing mappers from Java objects to a full-text index.
 This module implements most of the necessary logic, and defines SPIs to implement the bits that are specific to each mapper.
 
-There are currently only two implementations: the Hibernate ORM mapper, and the JavaBean mapper.
+There are currently only two implementations: the Hibernate ORM mapper, and the Stanadlone POJO mapper.
 The second one is mostly here to demonstrate that implementing a mapper that doesn't rely on Hibernate ORM is possible:
 we do not expect much real-life usage.
 

diff --git a/integrationtest/mapper/pojo-base/pom.xml b/integrationtest/mapper/pojo-base/pom.xml
@@ -27,7 +27,7 @@
         </dependency>
         <dependency>
             <groupId>org.hibernate.search</groupId>
-            <artifactId>hibernate-search-mapper-javabean</artifactId>
+            <artifactId>hibernate-search-mapper-pojo-standalone</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

diff --git a/...ernate/search/integrationtest/mapper/pojo/automaticindexing/DefaultReindexOnUpdateIT.java b/...ernate/search/integrationtest/mapper/pojo/automaticindexing/DefaultReindexOnUpdateIT.java
@@ -10,9 +10,9 @@
 
 import java.lang.invoke.MethodHandles;
 
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
-import org.hibernate.search.mapper.javabean.session.SearchSession;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.mapper.pojo.automaticindexing.ReindexOnUpdate;
 import org.hibernate.search.mapper.pojo.mapping.definition.programmatic.ProgrammaticMappingConfigurationContext;
 import org.hibernate.search.mapper.pojo.mapping.definition.programmatic.TypeMappingStep;
@@ -34,7 +34,7 @@ public class DefaultReindexOnUpdateIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	private SearchMapping mapping;
 

diff --git a/...test/java/org/hibernate/search/integrationtest/mapper/pojo/bootstrap/FailureReportIT.java b/...test/java/org/hibernate/search/integrationtest/mapper/pojo/bootstrap/FailureReportIT.java
@@ -11,7 +11,7 @@
 import java.lang.invoke.MethodHandles;
 
 import org.hibernate.search.engine.reporting.spi.EventContexts;
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
@@ -34,7 +34,7 @@ public class FailureReportIT {
 	private static final String FAILURE_REPORT_INTRODUCTION = "HSEARCH000520: Hibernate Search encountered failures during bootstrap."
 			+ " Failures:\n"
 			+ "\n"
-			+ "    JavaBean mapping: \n";
+			+ "    Standalone POJO mapping: \n";
 
 	@Rule
 	public BackendMock backendMock = new BackendMock();
@@ -43,7 +43,7 @@ public class FailureReportIT {
 	public ExpectedLog4jLog logged = ExpectedLog4jLog.create();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	/**
 	 * Test mapping with failures in the same context
@@ -77,14 +77,14 @@ class IndexedEntity {
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field1FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty'\n"
 		);
 		logged.expectEvent(
 				Level.ERROR,
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field2FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty'\n"
 		);
 
 		assertThatThrownBy(
@@ -134,14 +134,14 @@ class IndexedEntity {
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field1FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty1'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty1'\n"
 		);
 		logged.expectEvent(
 				Level.ERROR,
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field2FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty2'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty2'\n"
 		);
 
 		assertThatThrownBy(
@@ -199,14 +199,14 @@ class IndexedEntity2 {
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field1FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity1.class.getName() + "', path '.myProperty1'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity1.class.getName() + "', path '.myProperty1'\n"
 		);
 		logged.expectEvent(
 				Level.ERROR,
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field2FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity2.class.getName() + "', path '.myProperty2'\n"
+						+ "Standalone POJO mapping, type '" + IndexedEntity2.class.getName() + "', path '.myProperty2'\n"
 		);
 
 		assertThatThrownBy(
@@ -261,15 +261,15 @@ class IndexedEntity {
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field1FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty',"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty',"
 						+ " index '" + indexName + "', field 'failingField1'\n"
 		);
 		logged.expectEvent(
 				Level.ERROR,
 				ExceptionMatcherBuilder.isException( SearchException.class )
 						.withMessage( field2FailureMessage ).build(),
 				FAILURE_LOG_INTRODUCTION
-						+ "JavaBean mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty',"
+						+ "Standalone POJO mapping, type '" + IndexedEntity.class.getName() + "', path '.myProperty',"
 						+ " index '" + indexName + "', field 'failingField2'\n"
 		);
 

diff --git a/...e/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/lifecycle/CleanupIT.java b/...e/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/lifecycle/CleanupIT.java
@@ -15,7 +15,7 @@
 import java.util.function.Consumer;
 
 import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.StartupStubContainerExtractor;
-import org.hibernate.search.mapper.javabean.mapping.CloseableSearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.bridge.binding.IdentifierBindingContext;
 import org.hibernate.search.mapper.pojo.bridge.binding.PropertyBindingContext;
 import org.hibernate.search.mapper.pojo.bridge.binding.RoutingBindingContext;
@@ -35,7 +35,7 @@
 import org.hibernate.search.mapper.pojo.mapping.definition.programmatic.TypeMappingStep;
 import org.hibernate.search.mapper.pojo.model.path.PojoModelPath;
 import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.StartupStubBridge;
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
 import org.hibernate.search.util.common.SearchException;
 import org.hibernate.search.util.impl.integrationtest.common.rule.BackendMock;
 import org.hibernate.search.util.impl.integrationtest.common.stub.backend.index.impl.StubIndexManager;
@@ -61,7 +61,7 @@ public class CleanupIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	@Rule
 	public StaticCounters counters = new StaticCounters();

diff --git a/...rg/hibernate/search/integrationtest/mapper/pojo/loading/LoadingStrategyInheritanceIT.java b/...rg/hibernate/search/integrationtest/mapper/pojo/loading/LoadingStrategyInheritanceIT.java
@@ -17,10 +17,10 @@
 
 import org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy;
 import org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy;
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.loading.MassLoadingStrategies;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
-import org.hibernate.search.mapper.javabean.session.SearchSession;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.loading.MassLoadingStrategies;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
@@ -39,8 +39,8 @@ public class LoadingStrategyInheritanceIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper =
-			JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper =
+			StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	private final Map<Integer, RootEntity> entityMap = new HashMap<>();
 

diff --git a/...c/test/java/org/hibernate/search/integrationtest/mapper/pojo/mapping/SearchMappingIT.java b/...c/test/java/org/hibernate/search/integrationtest/mapper/pojo/mapping/SearchMappingIT.java
@@ -16,10 +16,10 @@
 
 import org.hibernate.search.engine.backend.Backend;
 import org.hibernate.search.engine.backend.index.IndexManager;
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.entity.SearchIndexedEntity;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
-import org.hibernate.search.mapper.javabean.scope.SearchScope;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.entity.SearchIndexedEntity;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.scope.SearchScope;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.AssociationInverseSide;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
@@ -45,8 +45,8 @@ public class SearchMappingIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper =
-			JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper =
+			StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	private SearchMapping mapping;
 

diff --git a/...hibernate/search/integrationtest/mapper/pojo/mapping/alternative/AlternativeBinderIT.java b/...hibernate/search/integrationtest/mapper/pojo/mapping/alternative/AlternativeBinderIT.java
@@ -12,9 +12,9 @@
 
 import org.hibernate.search.engine.backend.types.Projectable;
 import org.hibernate.search.mapper.pojo.bridge.builtin.annotation.AlternativeDiscriminator;
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
-import org.hibernate.search.mapper.javabean.session.SearchSession;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
 import org.hibernate.search.util.common.SearchException;
@@ -38,7 +38,7 @@ public class AlternativeBinderIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	@Test
 	public void smoke() {

diff --git a/...t/mapper/pojo/mapping/annotation/processing/CustomConstructorMappingAnnotationBaseIT.java b/...t/mapper/pojo/mapping/annotation/processing/CustomConstructorMappingAnnotationBaseIT.java
@@ -17,9 +17,9 @@
 import java.lang.invoke.MethodHandles;
 import java.util.Collections;
 
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
-import org.hibernate.search.mapper.javabean.session.SearchSession;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
@@ -53,7 +53,7 @@ public class CustomConstructorMappingAnnotationBaseIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	@Rule
 	public StaticCounters counters = new StaticCounters();

diff --git a/...test/mapper/pojo/mapping/annotation/processing/CustomPropertyMappingAnnotationBaseIT.java b/...test/mapper/pojo/mapping/annotation/processing/CustomPropertyMappingAnnotationBaseIT.java
@@ -20,8 +20,8 @@
 import java.util.Optional;
 import java.util.function.Predicate;
 
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
 import org.hibernate.search.mapper.pojo.extractor.builtin.BuiltinContainerExtractors;
 import org.hibernate.search.mapper.pojo.extractor.mapping.programmatic.ContainerExtractorPath;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
@@ -54,7 +54,7 @@ public class CustomPropertyMappingAnnotationBaseIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	/**
 	 * Basic test checking that a simple property mapping will be applied as expected.

diff --git a/...tiontest/mapper/pojo/mapping/annotation/processing/CustomTypeMappingAnnotationBaseIT.java b/...tiontest/mapper/pojo/mapping/annotation/processing/CustomTypeMappingAnnotationBaseIT.java
@@ -17,8 +17,8 @@
 import java.lang.invoke.MethodHandles;
 import java.util.Optional;
 
-import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
-import org.hibernate.search.mapper.javabean.mapping.SearchMapping;
+import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.StandalonePojoMappingSetupHelper;
+import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.DocumentId;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
 import org.hibernate.search.mapper.pojo.mapping.definition.annotation.processing.MappingAnnotatedType;
@@ -49,7 +49,7 @@ public class CustomTypeMappingAnnotationBaseIT {
 	public BackendMock backendMock = new BackendMock();
 
 	@Rule
-	public JavaBeanMappingSetupHelper setupHelper = JavaBeanMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
+	public StandalonePojoMappingSetupHelper setupHelper = StandalonePojoMappingSetupHelper.withBackendMock( MethodHandles.lookup(), backendMock );
 
 	/**
 	 * Basic test checking that a simple type mapping will be applied as expected.