Skip to content

Commit

Permalink
HSEARCH-3136 Rename IndexBindingContext et. al. to hopefully make the…
Browse files Browse the repository at this point in the history 
… names clearer

IndexModelBindingContext (parent interface) => IndexBindingContext
RootIndexModelBindingContext => IndexedEntityBindingContext
NonRootIndexModelBindingContext => IndexedEmbeddedBindingContext
  • Loading branch information
@yrodiere
yrodiere committed Mar 21, 2019
1 parent cc77804 commit 7649c90
Show file tree
Hide file tree
Showing 25 changed files with 89 additions and 92 deletions.
13 changes: 6 additions & 7 deletions ...rc/main/java/org/hibernate/search/engine/common/impl/IndexManagerBuildingStateHolder.java
View file
Expand Up @@ -21,7 +21,7 @@
import org.hibernate.search.engine.environment.bean.BeanReference;
import org.hibernate.search.engine.environment.bean.BeanHolder;
import org.hibernate.search.engine.logging.impl.Log;
import org.hibernate.search.engine.mapper.mapping.building.spi.RootIndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexedEntityBindingContext;
import org.hibernate.search.engine.mapper.mapping.spi.MappedIndexManager;
import org.hibernate.search.engine.backend.index.spi.IndexManagerBuilder;
import org.hibernate.search.engine.backend.index.spi.IndexManagerImplementor;
Expand All @@ -31,9 +31,8 @@
import org.hibernate.search.engine.cfg.spi.ConfigurationProperty;
import org.hibernate.search.engine.environment.bean.BeanProvider;
import org.hibernate.search.engine.backend.spi.BackendBuildContext;
import org.hibernate.search.engine.mapper.mapping.building.impl.RootIndexModelBindingContextImpl;
import org.hibernate.search.engine.mapper.mapping.building.impl.IndexedEntityBindingContextImpl;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexManagerBuildingState;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.util.common.AssertionFailure;
import org.hibernate.search.util.common.logging.impl.LoggerFactory;
import org.hibernate.search.util.common.impl.SuppressingCloser;
Expand Down Expand Up @@ -178,7 +177,7 @@ IndexManagerInitialBuildState<D> createIndexManagerBuildingState(
indexName, multiTenancyEnabled, backendBuildContext, defaultedIndexPropertySource
);
IndexSchemaRootNodeBuilder schemaRootNodeBuilder = builder.getSchemaRootNodeBuilder();
RootIndexModelBindingContext bindingContext = new RootIndexModelBindingContextImpl( schemaRootNodeBuilder );
IndexedEntityBindingContext bindingContext = new IndexedEntityBindingContextImpl( schemaRootNodeBuilder );
return new IndexManagerInitialBuildState<>( backendName, indexName, builder, bindingContext );
}

Expand All @@ -196,13 +195,13 @@ private class IndexManagerInitialBuildState<D extends DocumentElement> implement
private final String backendName;
private final String indexName;
private final IndexManagerBuilder<D> builder;
private final RootIndexModelBindingContext bindingContext;
private final IndexedEntityBindingContext bindingContext;

private IndexManagerImplementor<D> indexManager;

IndexManagerInitialBuildState(String backendName, String indexName,
IndexManagerBuilder<D> builder,
RootIndexModelBindingContext bindingContext) {
IndexedEntityBindingContext bindingContext) {
this.backendName = backendName;
this.indexName = indexName;
this.builder = builder;
Expand All @@ -224,7 +223,7 @@ public String getIndexName() {
}

@Override
public RootIndexModelBindingContext getRootBindingContext() {
public IndexedEntityBindingContext getIndexedEntityBindingContext() {
return bindingContext;
}

Expand Down
16 changes: 8 additions & 8 deletions ...mpl/AbstractIndexModelBindingContext.java → ...ing/impl/AbstractIndexBindingContext.java
View file
Expand Up @@ -19,18 +19,18 @@
import org.hibernate.search.engine.backend.document.model.dsl.spi.IndexSchemaObjectNodeBuilder;
import org.hibernate.search.engine.backend.document.model.dsl.spi.IndexSchemaRootNodeBuilder;
import org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactoryContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexSchemaContributionListener;
import org.hibernate.search.engine.mapper.mapping.building.spi.NonRootIndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexedEmbeddedBindingContext;
import org.hibernate.search.engine.mapper.model.spi.MappableTypeModel;

abstract class AbstractIndexModelBindingContext<B extends IndexSchemaObjectNodeBuilder> implements IndexModelBindingContext {
abstract class AbstractIndexBindingContext<B extends IndexSchemaObjectNodeBuilder> implements IndexBindingContext {

private final IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder;
final B indexSchemaObjectNodeBuilder;
private final ConfiguredIndexSchemaNestingContext nestingContext;

AbstractIndexModelBindingContext(IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder,
AbstractIndexBindingContext(IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder,
B indexSchemaObjectNodeBuilder, ConfiguredIndexSchemaNestingContext nestingContext) {
this.indexSchemaRootNodeBuilder = indexSchemaRootNodeBuilder;
this.indexSchemaObjectNodeBuilder = indexSchemaObjectNodeBuilder;
Expand Down Expand Up @@ -71,7 +71,7 @@ public IndexSchemaElement getSchemaElement(IndexSchemaContributionListener liste
}

@Override
public Optional<NonRootIndexModelBindingContext> addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel,
public Optional<IndexedEmbeddedBindingContext> addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel,
String relativePrefix, ObjectFieldStorage storage, Integer maxDepth, Set<String> includePaths) {
return nestingContext.addIndexedEmbeddedIfIncluded(
parentTypeModel, relativePrefix, maxDepth, includePaths,
Expand All @@ -80,7 +80,7 @@ public Optional<NonRootIndexModelBindingContext> addIndexedEmbeddedIfIncluded(Ma
}

private static class NestedContextBuilderImpl
implements ConfiguredIndexSchemaNestingContext.NestedContextBuilder<NonRootIndexModelBindingContext> {
implements ConfiguredIndexSchemaNestingContext.NestedContextBuilder<IndexedEmbeddedBindingContext> {

private final IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder;
private IndexSchemaObjectNodeBuilder currentNodeBuilder;
Expand All @@ -103,8 +103,8 @@ public void appendObject(String objectName) {
}

@Override
public NonRootIndexModelBindingContext build(ConfiguredIndexSchemaNestingContext nestingContext) {
return new NonRootIndexModelBindingContextImpl(
public IndexedEmbeddedBindingContext build(ConfiguredIndexSchemaNestingContext nestingContext) {
return new IndexedEmbeddedBindingContextImpl(
indexSchemaRootNodeBuilder,
currentNodeBuilder, parentIndexObjectReferences, nestingContext
);
Expand Down
12 changes: 5 additions & 7 deletions .../NonRootIndexModelBindingContextImpl.java → ...pl/IndexedEmbeddedBindingContextImpl.java
View file
Expand Up @@ -11,17 +11,15 @@

import org.hibernate.search.engine.backend.document.IndexObjectFieldReference;
import org.hibernate.search.engine.backend.document.model.dsl.spi.IndexSchemaRootNodeBuilder;
import org.hibernate.search.engine.backend.types.converter.spi.ToDocumentIdentifierValueConverter;
import org.hibernate.search.engine.backend.document.model.dsl.spi.IndexSchemaObjectNodeBuilder;
import org.hibernate.search.engine.mapper.mapping.building.spi.NonRootIndexModelBindingContext;
import org.hibernate.search.util.common.AssertionFailure;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexedEmbeddedBindingContext;

class NonRootIndexModelBindingContextImpl
extends AbstractIndexModelBindingContext<IndexSchemaObjectNodeBuilder>
implements NonRootIndexModelBindingContext {
class IndexedEmbeddedBindingContextImpl
extends AbstractIndexBindingContext<IndexSchemaObjectNodeBuilder>
implements IndexedEmbeddedBindingContext {
private final Collection<IndexObjectFieldReference> parentIndexObjectReferences;

NonRootIndexModelBindingContextImpl(IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder,
IndexedEmbeddedBindingContextImpl(IndexSchemaRootNodeBuilder indexSchemaRootNodeBuilder,
IndexSchemaObjectNodeBuilder indexSchemaObjectNodeBuilder,
Collection<IndexObjectFieldReference> parentIndexObjectReferences,
ConfiguredIndexSchemaNestingContext nestingContext) {
Expand Down
8 changes: 4 additions & 4 deletions ...mpl/RootIndexModelBindingContextImpl.java → ...impl/IndexedEntityBindingContextImpl.java
View file
Expand Up @@ -8,12 +8,12 @@

import org.hibernate.search.engine.backend.document.model.dsl.spi.IndexSchemaRootNodeBuilder;
import org.hibernate.search.engine.backend.types.converter.spi.ToDocumentIdentifierValueConverter;
import org.hibernate.search.engine.mapper.mapping.building.spi.RootIndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexedEntityBindingContext;

public class RootIndexModelBindingContextImpl extends AbstractIndexModelBindingContext<IndexSchemaRootNodeBuilder>
implements RootIndexModelBindingContext {
public class IndexedEntityBindingContextImpl extends AbstractIndexBindingContext<IndexSchemaRootNodeBuilder>
implements IndexedEntityBindingContext {

public RootIndexModelBindingContextImpl(IndexSchemaRootNodeBuilder indexSchemaObjectNodeBuilder) {
public IndexedEntityBindingContextImpl(IndexSchemaRootNodeBuilder indexSchemaObjectNodeBuilder) {
super( indexSchemaObjectNodeBuilder, indexSchemaObjectNodeBuilder, ConfiguredIndexSchemaNestingContext.root() );
}

Expand Down
4 changes: 2 additions & 2 deletions ...uilding/spi/IndexModelBindingContext.java → ...ing/building/spi/IndexBindingContext.java
View file
Expand Up @@ -21,7 +21,7 @@
* <p>
* Provides entry points to add fields to the index schema and to generate new contexts for indexed-embeddeds.
*/
public interface IndexModelBindingContext {
public interface IndexBindingContext {

/**
* @return The type factory of the bound index, allowing to create field types.
Expand All @@ -48,6 +48,6 @@ public interface IndexModelBindingContext {
* @param includePaths The exhaustive list of paths of fields that are to be included. {@code null} for no limit.
* @return The element in the index schema that this context points to.
*/
Optional<NonRootIndexModelBindingContext> addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel,
Optional<IndexedEmbeddedBindingContext> addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel,
String relativePrefix, ObjectFieldStorage storage, Integer maxDepth, Set<String> includePaths);
}
2 changes: 1 addition & 1 deletion ...va/org/hibernate/search/engine/mapper/mapping/building/spi/IndexManagerBuildingState.java
View file
Expand Up @@ -16,7 +16,7 @@ public interface IndexManagerBuildingState<D extends DocumentElement> {

String getIndexName();

RootIndexModelBindingContext getRootBindingContext();
IndexedEntityBindingContext getIndexedEntityBindingContext();

MappedIndexManager<D> build();

Expand Down
4 changes: 2 additions & 2 deletions .../spi/NonRootIndexModelBindingContext.java → ...ng/spi/IndexedEmbeddedBindingContext.java
View file
Expand Up @@ -13,9 +13,9 @@
/**
* The binding context associated to a specific non-root node in the entity tree.
*
* @see IndexModelBindingContext
* @see IndexBindingContext
*/
public interface NonRootIndexModelBindingContext extends IndexModelBindingContext {
public interface IndexedEmbeddedBindingContext extends IndexBindingContext {

/**
* @return The list of index object fields between the parent binding context and this context.
Expand Down
6 changes: 3 additions & 3 deletions ...ing/spi/RootIndexModelBindingContext.java → ...ding/spi/IndexedEntityBindingContext.java
View file
Expand Up @@ -11,12 +11,12 @@
/**
* The binding context associated to the root node in the entity tree.
*
* @see IndexModelBindingContext
* @see IndexBindingContext
*/
public interface RootIndexModelBindingContext extends IndexModelBindingContext {
public interface IndexedEntityBindingContext extends IndexBindingContext {

/**
* Inform the backend that documents for this index will always be provided along
* Inform the backend that documents for the mapped index will always be provided along
* with an explicit routing key,
* to be used to route the document to a specific shard.
*/
Expand Down
4 changes: 2 additions & 2 deletions ...rch/integrationtest/backend/elasticsearch/analysis/ElasticsearchAnalysisConfigurerIT.java
View file
Expand Up @@ -11,7 +11,7 @@
import org.hibernate.search.backend.elasticsearch.analysis.ElasticsearchAnalysisConfigurer;
import org.hibernate.search.backend.elasticsearch.analysis.model.dsl.ElasticsearchAnalysisDefinitionContainerContext;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.util.common.SearchException;
import org.hibernate.search.util.impl.integrationtest.common.FailureReportUtils;
Expand Down Expand Up @@ -345,7 +345,7 @@ private void setup(String analysisConfigurer) {
setup( analysisConfigurer, c -> { } );
}

private void setup(String analysisConfigurer, Consumer<IndexModelBindingContext> mappingContributor) {
private void setup(String analysisConfigurer, Consumer<IndexBindingContext> mappingContributor) {
setupHelper.withDefaultConfiguration( BACKEND_NAME )
.withProperty(
"backends." + BACKEND_NAME + "." + ElasticsearchBackendSettings.ANALYSIS_CONFIGURER,
Expand Down
4 changes: 2 additions & 2 deletions ...earch/integrationtest/backend/elasticsearch/management/ElasticsearchSchemaCreationIT.java
View file
Expand Up @@ -16,7 +16,7 @@
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchIndexLifecycleStrategyName;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchIndexSettings;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.elasticsearch.testsupport.util.TestElasticsearchClient;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.util.impl.test.annotation.PortedFromSearch5;
Expand Down Expand Up @@ -199,7 +199,7 @@ public void textField_noNorms() throws Exception {
);
}

private void setup(Consumer<IndexModelBindingContext> mappingContributor) {
private void setup(Consumer<IndexBindingContext> mappingContributor) {
setupHelper.withDefaultConfiguration( BACKEND_NAME )
.withIndex(
INDEX_NAME,
Expand Down
4 changes: 2 additions & 2 deletions ...st/java/org/hibernate/search/integrationtest/backend/lucene/LuceneDocumentModelDslIT.java
View file
Expand Up @@ -9,7 +9,7 @@
import java.util.function.Consumer;

import org.hibernate.search.engine.reporting.spi.EventContexts;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.util.common.SearchException;
import org.hibernate.search.util.impl.integrationtest.common.FailureReportUtils;
Expand Down Expand Up @@ -59,7 +59,7 @@ public void unknownNormalizer() {
) );
}

private void setup(Consumer<IndexModelBindingContext> mappingContributor) {
private void setup(Consumer<IndexBindingContext> mappingContributor) {
setupHelper.withDefaultConfiguration()
.withIndex(
INDEX_NAME,
Expand Down
4 changes: 2 additions & 2 deletions .../hibernate/search/integrationtest/backend/lucene/analysis/LuceneAnalysisConfigurerIT.java
View file
Expand Up @@ -11,7 +11,7 @@
import org.hibernate.search.backend.lucene.analysis.LuceneAnalysisConfigurer;
import org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalysisDefinitionContainerContext;
import org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.util.common.SearchException;
import org.hibernate.search.util.impl.integrationtest.common.FailureReportUtils;
Expand Down Expand Up @@ -185,7 +185,7 @@ private void setup(String analysisConfigurer) {
setup( analysisConfigurer, c -> { } );
}

private void setup(String analysisConfigurer, Consumer<IndexModelBindingContext> mappingContributor) {
private void setup(String analysisConfigurer, Consumer<IndexBindingContext> mappingContributor) {
setupHelper.withDefaultConfiguration( BACKEND_NAME )
.withProperty(
"backends." + BACKEND_NAME + "." + LuceneBackendSettings.ANALYSIS_CONFIGURER,
Expand Down
8 changes: 4 additions & 4 deletions ...tck/src/main/java/org/hibernate/search/integrationtest/backend/tck/DocumentElementIT.java
View file
Expand Up @@ -21,9 +21,9 @@
import org.hibernate.search.engine.backend.document.model.dsl.IndexSchemaObjectField;
import org.hibernate.search.engine.backend.document.model.dsl.ObjectFieldStorage;
import org.hibernate.search.engine.backend.index.spi.IndexWorkPlan;
import org.hibernate.search.engine.mapper.mapping.building.spi.NonRootIndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexedEmbeddedBindingContext;
import org.hibernate.search.util.impl.integrationtest.common.stub.mapper.StubMappingIndexManager;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.tck.testsupport.configuration.DefaultAnalysisDefinitions;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.engine.spatial.GeoPoint;
Expand Down Expand Up @@ -275,7 +275,7 @@ private static class IndexMapping extends AllTypesMapping {
final FirstLevelObjectMapping nestedObject;
final FirstLevelObjectMapping excludingObject;

IndexMapping(IndexModelBindingContext ctx) {
IndexMapping(IndexBindingContext ctx) {
super( ctx.getSchemaElement() );
IndexSchemaElement root = ctx.getSchemaElement();
IndexSchemaObjectField flattenedObjectField = root.objectField( "flattenedObject", ObjectFieldStorage.FLATTENED );
Expand All @@ -284,7 +284,7 @@ private static class IndexMapping extends AllTypesMapping {
nestedObject = new FirstLevelObjectMapping( nestedObjectField );

// Simulate an embedded context which excludes every subfield
NonRootIndexModelBindingContext excludingEmbeddedContext = ctx.addIndexedEmbeddedIfIncluded(
IndexedEmbeddedBindingContext excludingEmbeddedContext = ctx.addIndexedEmbeddedIfIncluded(
new StubTypeModel( "embedded" ),
"excludingObject.", ObjectFieldStorage.FLATTENED,
null, Collections.singleton( "pathThatDoesNotMatchAnything" )
Expand Down
4 changes: 2 additions & 2 deletions ...ck/src/main/java/org/hibernate/search/integrationtest/backend/tck/DocumentModelDslIT.java
View file
Expand Up @@ -17,7 +17,7 @@
import org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeTerminalContext;
import org.hibernate.search.engine.backend.types.dsl.StandardIndexFieldTypeContext;
import org.hibernate.search.engine.backend.document.model.dsl.IndexSchemaObjectField;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexModelBindingContext;
import org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext;
import org.hibernate.search.integrationtest.backend.tck.testsupport.configuration.DefaultAnalysisDefinitions;
import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
import org.hibernate.search.engine.reporting.spi.EventContexts;
Expand Down Expand Up @@ -493,7 +493,7 @@ private IndexFieldTypeTerminalContext<String> irrelevantTypeContributor(IndexFie
return factoryContext.asString();
}

private void setup(Consumer<IndexModelBindingContext> mappingContributor) {
private void setup(Consumer<IndexBindingContext> mappingContributor) {
setupHelper.withDefaultConfiguration()
.withIndex(
INDEX_NAME,
Expand Down

0 comments on commit 7649c90

Please sign in to comment.