Package org.hibernate.search.engine.mapper.mapping.building.impl

Class IndexedEntityBindingContextImpl

java.lang.Object

org.hibernate.search.engine.mapper.mapping.building.impl.IndexedEntityBindingContextImpl

All Implemented Interfaces:

IndexBindingContext, IndexedEntityBindingContext

public class IndexedEntityBindingContextImpl
extends Object
implements IndexedEntityBindingContext

Constructor Summary

Constructors

Constructor	Description
IndexedEntityBindingContextImpl(IndexedEntityBindingMapperContext mapperContext, IndexRootBuilder indexRootBuilder)

Method Summary

Modifier and Type	Method	Description
Optional<IndexedEmbeddedBindingContext>	addIndexedEmbeddedIfIncluded(MappingElement mappingElement, String relativePrefix, ObjectStructure structure, TreeFilterDefinition filter, boolean multiValued)
IndexFieldTypeFactory	createTypeFactory(IndexFieldTypeDefaultsProvider defaultsProvider)	Use this method to provide some defaults to the current request.
void	explicitRouting()	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.
<I> void	idDslConverter(Class<I> valueType, ToDocumentValueConverter<I,String> converter)
<I> void	idProjectionConverter(Class<I> valueType, FromDocumentValueConverter<String,I> converter)
IndexSchemaElement	schemaElement()
IndexSchemaElement	schemaElement(TreeContributionListener listener)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.search.engine.mapper.mapping.building.spi.IndexBindingContext

addIndexedEmbeddedIfIncluded, createTypeFactory, createTypeFactory, schemaElement, schemaElement

Constructor Detail

IndexedEntityBindingContextImpl

public IndexedEntityBindingContextImpl(IndexedEntityBindingMapperContext mapperContext,
                                       IndexRootBuilder indexRootBuilder)

Method Detail

explicitRouting

public void explicitRouting()

Description copied from interface: IndexedEntityBindingContext

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.

Specified by:

explicitRouting in interface IndexedEntityBindingContext

idDslConverter

public <I> void idDslConverter(Class<I> valueType,
                               ToDocumentValueConverter<I,String> converter)

Specified by:

idDslConverter in interface IndexedEntityBindingContext

idProjectionConverter

public <I> void idProjectionConverter(Class<I> valueType,
                                      FromDocumentValueConverter<String,I> converter)

Specified by:

idProjectionConverter in interface IndexedEntityBindingContext

toString

public String toString()

Overrides:

toString in class Object

createTypeFactory

public IndexFieldTypeFactory createTypeFactory(IndexFieldTypeDefaultsProvider defaultsProvider)

Description copied from interface: IndexBindingContext

Use this method to provide some defaults to the current request. IndexFieldTypeDefaultsProvider instance will be overridden by a subsequent request.

Specified by:

createTypeFactory in interface IndexBindingContext

Parameters:

defaultsProvider - The defaults to apply

Returns:

The type factory of the bound index, allowing to create field types.

schemaElement

public IndexSchemaElement schemaElement()

Specified by:

schemaElement in interface IndexBindingContext

Returns:

The element in the index schema that this context points to.

schemaElement

public IndexSchemaElement schemaElement(TreeContributionListener listener)

Specified by:

schemaElement in interface IndexBindingContext

Parameters:

listener - A listener to notify when operations are executed on the returned schema element.

Returns:

The element in the index schema that this context points to, with a wrapper that ensures the given listener will be called when operations are executed on the schema element.

addIndexedEmbeddedIfIncluded

public Optional<IndexedEmbeddedBindingContext> addIndexedEmbeddedIfIncluded(MappingElement mappingElement,
                                                                            String relativePrefix,
                                                                            ObjectStructure structure,
                                                                            TreeFilterDefinition filter,
                                                                            boolean multiValued)

Specified by:

addIndexedEmbeddedIfIncluded in interface IndexBindingContext

Parameters:

mappingElement - A unique representation of this indexed-embedded; if the same indexed-embedded is applied in multiple places, this method must be called with mapping elements that are equal according to MappingElement.equals(Object)/MappingElement.hashCode().

relativePrefix - The prefix to apply to all index fields created in the context of the indexed-embedded.

structure - The structure of all object fields created as part of the relativePrefix.

filter - The filter definition (included paths, ...).

multiValued - Whether the property with an indexed-embedded is to be considered as multi-valued (i.e. multiple indexed-embedded objects may be processed for a single "embedding" object).

Returns:

A new indexed-embedded binding context, or Optional.empty().