Package io.jmix.search.index.mapping

Class ContributedIndexDefinition.Builder

java.lang.Object

io.jmix.search.index.mapping.ContributedIndexDefinition.Builder

Enclosing class:

ContributedIndexDefinition

public static class ContributedIndexDefinition.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	entityName
protected ExtendedSearchSettings	extendedSearchSettings
protected Predicate<Object>	indexablePredicate
protected @Nullable String	indexName
protected final MappingDefinition	mappingDefinition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String entityName, MappingDefinition mappingDefinition)

Method Summary

Modifier and Type	Method	Description
ContributedIndexDefinition	build()
ContributedIndexDefinition.Builder	withExtendedSearchSettings(ExtendedSearchSettings extendedSearchSettings)	Sets the extended search settings of the index.
ContributedIndexDefinition.Builder	withIndexablePredicate(Predicate<Object> indexablePredicate)	Sets the predicate that decides whether an instance is indexed.
ContributedIndexDefinition.Builder	withIndexName(@Nullable String indexName)	Sets an explicit index name.

Methods inherited from class java.lang.Object

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

Field Details

entityName

protected final String entityName

mappingDefinition

protected final MappingDefinition mappingDefinition

indexName

protected @Nullable String indexName

extendedSearchSettings

protected ExtendedSearchSettings extendedSearchSettings

indexablePredicate

protected Predicate<Object> indexablePredicate

Constructor Details

Builder

protected Builder(String entityName,
 MappingDefinition mappingDefinition)

Method Details

withIndexName

public ContributedIndexDefinition.Builder withIndexName(@Nullable String indexName)

Sets an explicit index name. By default, the name is derived from the entity name.

Parameters:

indexName - index name, or null to derive it from the entity name

Returns:

builder

withExtendedSearchSettings

public ContributedIndexDefinition.Builder withExtendedSearchSettings(ExtendedSearchSettings extendedSearchSettings)

Sets the extended search settings of the index. By default, extended search is disabled.

Parameters:

extendedSearchSettings - extended search settings

Returns:

builder

See Also:

• ExtendedSearch

withIndexablePredicate

public ContributedIndexDefinition.Builder withIndexablePredicate(Predicate<Object> indexablePredicate)

Sets the predicate that decides whether an instance is indexed. By default, every instance is indexed.

Parameters:

indexablePredicate - predicate that receives an entity instance

Returns:

builder

See Also:

• IndexablePredicate

build

public ContributedIndexDefinition build()