org.hibernate.search.engine.mapper.mapping.building.spi

Interface IndexBindingContext

All Known Subinterfaces:

IndexedEmbeddedBindingContext, IndexedEntityBindingContext

public interface IndexBindingContext

The binding context associated to a specific node in the entity tree.

The context includes in particular the corresponding node in the index schema tree.

Provides entry points to add fields to the index schema and to generate new contexts for indexed-embeddeds.

Method Summary

Modifier and Type	Method and Description
Optional<IndexedEmbeddedBindingContext>	addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel, String relativePrefix, ObjectFieldStorage storage, Integer maxDepth, Set<String> includePaths)
IndexSchemaElement	getSchemaElement()
IndexSchemaElement	getSchemaElement(IndexSchemaContributionListener listener)
IndexFieldTypeFactoryContext	getTypeFactory()

Method Detail

getTypeFactory

IndexFieldTypeFactoryContext getTypeFactory()

Returns:

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

getSchemaElement

IndexSchemaElement getSchemaElement()

Returns:

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

getSchemaElement

IndexSchemaElement getSchemaElement(IndexSchemaContributionListener listener)

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

Optional<IndexedEmbeddedBindingContext> addIndexedEmbeddedIfIncluded(MappableTypeModel parentTypeModel,
                                                                     String relativePrefix,
                                                                     ObjectFieldStorage storage,
                                                                     Integer maxDepth,
                                                                     Set<String> includePaths)

Parameters:

parentTypeModel - The model representing the type holding the property with an indexed-embedded.

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

storage - The storage type to use for all object fields created as part of the relativePrefix.

maxDepth - The maximum depth beyond which all created fields will be ignored. null for no limit.

includePaths - The exhaustive list of paths of fields that are to be included. null for no limit.

Returns:

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