HSEARCH-4615 Remove remaining methods from builder that were moved to…

… configurer
hibernate · Dec 22, 2022 · 2b1681e · 2b1681e
1 parent 66f1b3d
commit 2b1681e
Show file tree

Hide file tree

Showing 28 changed files with 251 additions and 319 deletions.
diff --git a/documentation/src/main/asciidoc/reference/mapper-pojo-standalone.asciidoc b/documentation/src/main/asciidoc/reference/mapper-pojo-standalone.asciidoc
@@ -34,20 +34,6 @@ at the moment.
 
 Starting up Hibernate Search with the Standalone POJO Mapper is explicit and involves a builder:
 
-.Starting up Hibernate Search with the Standalone POJO Mapper
-====
-[source, JAVA, indent=0]
-----
-include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoEntryPointsIT.java[tags=setup]
-----
-<1> Create a builder.
-<2> Declare *all* entity types that Hibernate Search may need to work with.
-<3> Set configuration properties (see also <<configuration>>).
-<4> Build the `SearchMapping`.
-====
-
-Alternatively a configurer class implementing `StandalonePojoMappingConfigurer` can be provided.
-
 .Starting up Hibernate Search with the Standalone POJO Mapper and Configurer
 ====
 [source, JAVA, indent=0]
@@ -57,7 +43,7 @@ include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/e
 <1> Declare *all* entity types that Hibernate Search may need to work with.
 <2> Set additional configuration exposed through the context.
 ----
-include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoConfigurerIT.java[tags=setup]
+include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoEntryPointsIT.java[tags=setup]
 ----
 <1> Create a builder.
 <2> Set configurer.

diff --git a/...e/search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoConfigurerIT.java b/...e/search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoConfigurerIT.java
diff --git a/.../search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoEntryPointsIT.java b/.../search/documentation/mapper/pojo/standalone/entrypoints/StandalonePojoEntryPointsIT.java
@@ -37,14 +37,19 @@ public class StandalonePojoEntryPointsIT {
 	public void setup() {
 		// tag::setup[]
 		CloseableSearchMapping searchMapping = SearchMapping.builder() // <1>
-				.addEntityType( Book.class ) // <2>
-				.addEntityType( Associate.class )
-				.addEntityType( Manager.class )
-				.property( "hibernate.search.backend.hosts", // <3>
-						"elasticsearch.mycompany.com" )
+				.property(
+						"hibernate.search.mapping.configurer", // <2>
+						"class:org.hibernate.search.documentation.mapper.pojo.standalone.entrypoints.StandalonePojoConfigurer"
+				)
+				.property(
+						"hibernate.search.backend.hosts", // <3>
+						"elasticsearch.mycompany.com"
+				)
 				// end::setup[]
-				.properties( TestConfiguration.standalonePojoMapperProperties( configurationProvider,
-						BackendConfigurations.simple() ) )
+				.properties( TestConfiguration.standalonePojoMapperProperties(
+						configurationProvider,
+						BackendConfigurations.simple()
+				) )
 				// tag::setup[]
 				.build(); // <4>
 		// end::setup[]
@@ -64,6 +69,14 @@ public void cleanup() {
 		}
 	}
 
+	@Test
+	public void mappingContainsExpectedEntities() {
+		assertThat( theSearchMapping.allIndexedEntities() )
+				.extracting( SearchIndexedEntity::name )
+				.contains( "Book", "Associate", "Manager" )
+		;
+	}
+
 	@Test
 	public void searchSession() {
 		// tag::searchSession-simple[]

diff --git a/.../standalone/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java b/.../standalone/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java
@@ -15,6 +15,7 @@
 import org.hibernate.search.engine.search.query.SearchResult;
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
 import org.hibernate.search.util.impl.integrationtest.common.rule.BackendConfiguration;
@@ -36,8 +37,13 @@ public void setup() {
 		if ( BackendConfiguration.isLucene() ) {
 			// tag::setup-lucene[]
 			CloseableSearchMapping searchMapping = SearchMapping.builder()
-					.addEntityType( Book.class )
-					.addEntityType( Author.class )
+					.property(
+							"hibernate.search.mapping.configurer",
+							(StandalonePojoMappingConfigurer) context -> {
+								context.addEntityType( Book.class )
+										.addEntityType( Author.class );
+							}
+					)
 					.property( "hibernate.search.backend.directory.root",
 							"some/filesystem/path" )
 					.property( "hibernate.search.backend.analysis.configurer",
@@ -53,8 +59,13 @@ public void setup() {
 		else if ( BackendConfiguration.isElasticsearch() ) {
 			// tag::setup-elasticsearch[]
 			CloseableSearchMapping searchMapping = SearchMapping.builder()
-					.addEntityType( Book.class )
-					.addEntityType( Author.class )
+					.property(
+							"hibernate.search.mapping.configurer",
+							(StandalonePojoMappingConfigurer) context -> {
+								context.addEntityType( Book.class )
+										.addEntityType( Author.class );
+							}
+					)
 					.property( "hibernate.search.backend.hosts",
 							"elasticsearch.mycompany.com" )
 					.property( "hibernate.search.backend.analysis.configurer",

diff --git a/...tandalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java b/...tandalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java
@@ -16,6 +16,7 @@
 import org.hibernate.search.engine.search.query.SearchResult;
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.scope.SearchScope;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
@@ -38,8 +39,13 @@ public void setup() {
 		if ( BackendConfiguration.isLucene() ) {
 			// tag::setup-lucene[]
 			CloseableSearchMapping searchMapping = SearchMapping.builder() // <1>
-					.addEntityType( Book.class ) // <2>
-					.addEntityType( Author.class )
+					.property(
+							"hibernate.search.mapping.configurer",
+							(StandalonePojoMappingConfigurer) context -> {
+								context.addEntityType( Book.class ) // <2>
+										.addEntityType( Author.class );
+							}
+					)
 					.property( "hibernate.search.backend.directory.root",
 							"some/filesystem/path" ) // <3>
 					// end::setup-lucene[]
@@ -53,8 +59,13 @@ public void setup() {
 		else if ( BackendConfiguration.isElasticsearch() ) {
 			// tag::setup-elasticsearch[]
 			CloseableSearchMapping searchMapping = SearchMapping.builder() // <1>
-					.addEntityType( Book.class ) // <2>
-					.addEntityType( Author.class )
+					.property(
+							"hibernate.search.mapping.configurer",
+							(StandalonePojoMappingConfigurer) context -> {
+								context.addEntityType( Book.class ) // <2>
+										.addEntityType( Author.class );
+							}
+					)
 					.property( "hibernate.search.backend.hosts",
 							"elasticsearch.mycompany.com" ) // <3>
 					.property( "hibernate.search.backend.protocol",

diff --git a/...nate/search/documentation/mapper/pojo/standalone/loading/StandalonePojoMassLoadingIT.java b/...nate/search/documentation/mapper/pojo/standalone/loading/StandalonePojoMassLoadingIT.java
@@ -18,6 +18,7 @@
 import org.hibernate.search.documentation.testsupport.TestConfiguration;
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
 
@@ -51,10 +52,15 @@ public void setup() {
 				new MyDatastore( entities );
 		// tag::setup[]
 		CloseableSearchMapping searchMapping = SearchMapping.builder() // <2>
-				.addEntityType( Book.class, context -> // <3>
-						context.massLoadingStrategy(
-								new MyMassLoadingStrategy<>( datastore, Book.class )
-						) )
+				.property(
+						"hibernate.search.mapping.configurer",
+						(StandalonePojoMappingConfigurer) configurerContext -> {
+							configurerContext.addEntityType( Book.class, context -> // <3>
+									context.massLoadingStrategy(
+											new MyMassLoadingStrategy<>( datastore, Book.class )
+									) );
+						}
+				)
 				// end::setup[]
 				.properties( TestConfiguration.standalonePojoMapperProperties(
 						configurationProvider,

diff --git a/...search/documentation/mapper/pojo/standalone/loading/StandalonePojoSelectionLoadingIT.java b/...search/documentation/mapper/pojo/standalone/loading/StandalonePojoSelectionLoadingIT.java
@@ -21,6 +21,7 @@
 import org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy;
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
 
@@ -52,10 +53,15 @@ public void setup() {
 
 		// tag::setup[]
 		CloseableSearchMapping searchMapping = SearchMapping.builder() // <1>
-				.addEntityType( Book.class, context -> // <2>
-						context.selectionLoadingStrategy(
-								new MySelectionLoadingStrategy<>( Book.class )
-						) )
+				.property(
+						"hibernate.search.mapping.configurer",
+						(StandalonePojoMappingConfigurer) c -> {
+							c.addEntityType( Book.class, context -> // <2>
+									context.selectionLoadingStrategy(
+											new MySelectionLoadingStrategy<>( Book.class )
+									) );
+						}
+				)
 				// end::setup[]
 				.properties( TestConfiguration.standalonePojoMapperProperties(
 						configurationProvider,

diff --git a/...te/search/documentation/mapper/pojo/standalone/mapping/config/MappingConfigurationIT.java b/...te/search/documentation/mapper/pojo/standalone/mapping/config/MappingConfigurationIT.java
@@ -18,6 +18,7 @@
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMappingBuilder;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
 
@@ -38,21 +39,28 @@ public void setup() {
 		// tag::setup[]
 		SearchMappingBuilder builder = SearchMapping.builder()
 				// end::setup[]
-				.properties( TestConfiguration.standalonePojoMapperProperties( configurationProvider,
-						BackendConfigurations.simple() ) )
+				.properties( TestConfiguration.standalonePojoMapperProperties(
+						configurationProvider,
+						BackendConfigurations.simple()
+				) )
 				// tag::setup[]
-				.addEntityType( Book.class ); // <1>
-
-		builder.annotationMapping() // <2>
-				.discoverAnnotationsFromReferencedTypes( false )
-				.discoverAnnotatedTypesFromRootMappingAnnotations( false );
-
-		ProgrammaticMappingConfigurationContext mappingContext = builder.programmaticMapping(); // <3>
-		TypeMappingStep bookMapping = mappingContext.type( Book.class );
-		bookMapping.indexed();
-		bookMapping.property( "id" ).documentId();
-		bookMapping.property( "title" )
-				.fullTextField().analyzer( "english" );
+				.property(
+						"hibernate.search.mapping.configurer",
+						(StandalonePojoMappingConfigurer) context -> {
+							context.addEntityType( Book.class ); // <1>
+
+							context.annotationMapping() // <2>
+									.discoverAnnotationsFromReferencedTypes( false )
+									.discoverAnnotatedTypesFromRootMappingAnnotations( false );
+
+							ProgrammaticMappingConfigurationContext mappingContext = context.programmaticMapping(); // <3>
+							TypeMappingStep bookMapping = mappingContext.type( Book.class );
+							bookMapping.indexed();
+							bookMapping.property( "id" ).documentId();
+							bookMapping.property( "title" )
+									.fullTextField().analyzer( "english" );
+						}
+				);
 
 		CloseableSearchMapping searchMapping = builder.build();
 		// end::setup[]

diff --git a/...earch/documentation/mapper/pojo/standalone/multitenancy/StandalonePojoMultiTenancyIT.java b/...earch/documentation/mapper/pojo/standalone/multitenancy/StandalonePojoMultiTenancyIT.java
@@ -12,6 +12,7 @@
 import org.hibernate.search.documentation.testsupport.TestConfiguration;
 import org.hibernate.search.mapper.pojo.standalone.mapping.CloseableSearchMapping;
 import org.hibernate.search.mapper.pojo.standalone.mapping.SearchMapping;
+import org.hibernate.search.mapper.pojo.standalone.mapping.StandalonePojoMappingConfigurer;
 import org.hibernate.search.mapper.pojo.standalone.session.SearchSession;
 import org.hibernate.search.util.impl.integrationtest.common.TestConfigurationProvider;
 
@@ -31,11 +32,14 @@ public class StandalonePojoMultiTenancyIT {
 	public void setup() {
 		// tag::setup[]
 		CloseableSearchMapping searchMapping = SearchMapping.builder() // <1>
-				.addEntityType( Book.class )
+				// ...
 				.property( "hibernate.search.mapping.multi_tenancy.enabled", true ) // <2>
 				// end::setup[]
 				.properties( TestConfiguration.standalonePojoMapperProperties( configurationProvider,
 						BackendConfigurations.simple() ) )
+				.property( "hibernate.search.mapping.configurer",
+						(StandalonePojoMappingConfigurer) context -> context.addEntityTypes( Book.class )
+				)
 				// tag::setup[]
 				.build(); // <3>
 		// end::setup[]

diff --git a/...n/src/test/java/org/hibernate/search/documentation/testsupport/BackendConfigurations.java b/...n/src/test/java/org/hibernate/search/documentation/testsupport/BackendConfigurations.java
@@ -49,7 +49,7 @@ public static BackendConfiguration hashBasedSharding(int shardCount) {
 			case "lucene":
 				return new DocumentationLuceneBackendConfiguration() {
 					@Override
-					public <C extends MappingSetupHelper<C, ?, ?>.AbstractSetupContext> C setup(C setupContext,
+					public <C extends MappingSetupHelper<C, ?, ?, ?>.AbstractSetupContext> C setup(C setupContext,
 							String backendNameOrNull, TestConfigurationProvider configurationProvider) {
 						return super.setup( setupContext, backendNameOrNull, configurationProvider )
 								.withBackendProperty(
@@ -63,7 +63,7 @@ public static BackendConfiguration hashBasedSharding(int shardCount) {
 			case "elasticsearch":
 				return new DocumentationElasticsearchBackendConfiguration() {
 					@Override
-					public <C extends MappingSetupHelper<C, ?, ?>.AbstractSetupContext> C setup(C setupContext,
+					public <C extends MappingSetupHelper<C, ?, ?, ?>.AbstractSetupContext> C setup(C setupContext,
 							String backendNameOrNull, TestConfigurationProvider configurationProvider) {
 						return super.setup( setupContext, backendNameOrNull, configurationProvider )
 								.withBackendProperty( ElasticsearchIndexSettings.SCHEMA_MANAGEMENT_SETTINGS_FILE,

diff --git a/...rc/test/java/org/hibernate/search/documentation/testsupport/DocumentationSetupHelper.java b/...rc/test/java/org/hibernate/search/documentation/testsupport/DocumentationSetupHelper.java
@@ -29,7 +29,7 @@
 import org.hibernate.search.util.impl.integrationtest.mapper.orm.SimpleSessionFactoryBuilder;
 
 public final class DocumentationSetupHelper
-		extends MappingSetupHelper<DocumentationSetupHelper.SetupContext, SimpleSessionFactoryBuilder, SessionFactory> {
+		extends MappingSetupHelper<DocumentationSetupHelper.SetupContext, SimpleSessionFactoryBuilder, SimpleSessionFactoryBuilder, SessionFactory> {
 
 	public static List<DocumentationSetupHelper> testParamsForBothAnnotationsAndProgrammatic(
 			BackendConfiguration backendConfiguration,
@@ -130,7 +130,7 @@ protected void close(SessionFactory toClose) {
 	}
 
 	public final class SetupContext
-			extends MappingSetupHelper<SetupContext, SimpleSessionFactoryBuilder, SessionFactory>.AbstractSetupContext {
+			extends MappingSetupHelper<SetupContext, SimpleSessionFactoryBuilder, SimpleSessionFactoryBuilder, SessionFactory>.AbstractSetupContext {
 
 		// Use a LinkedHashMap for deterministic iteration
 		private final Map<String, Object> overriddenProperties = new LinkedHashMap<>();
@@ -172,6 +172,11 @@ protected SimpleSessionFactoryBuilder createBuilder() {
 			return new SimpleSessionFactoryBuilder();
 		}
 
+		@Override
+		protected void consumeBeforeBuildConfigurations(SimpleSessionFactoryBuilder builder, List<Consumer<SimpleSessionFactoryBuilder>> consumers) {
+			consumers.forEach( c -> c.accept( builder ) );
+		}
+
 		@Override
 		protected SessionFactory build(SimpleSessionFactoryBuilder builder) {
 			return builder.build();