Package io.jmix.search.index

Class IndexConfiguration

java.lang.Object

io.jmix.search.index.IndexConfiguration

public class IndexConfiguration
extends Object

Contains configuration of index related to some entity

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<Class<?>>	affectedEntityClasses
protected final Class<?>	entityClass
protected final String	entityName
protected final ExtendedSearchSettings	extendedSearchSettings
protected final Predicate<Object>	indexablePredicate
protected final String	indexName
protected final IndexMappingConfiguration	mapping

Constructor Summary

Constructors

Constructor	Description
IndexConfiguration(String entityName, Class<?> entityClass, String indexName, IndexMappingConfiguration mapping, Set<Class<?>> affectedEntityClasses, Predicate<Object> indexablePredicate, ExtendedSearchSettings extendedSearchSettings)

Method Summary

Modifier and Type	Method	Description
Set<Class<?>>	getAffectedEntityClasses()	Gets java classes of all entities presented in indexed properties.
Class<?>	getEntityClass()	Gets java class of entity indexed in this index
String	getEntityName()	Gets name of entity indexed in this index
ExtendedSearchSettings	getExtendedSearchSettings()
Predicate<Object>	getIndexablePredicate()	Gets Predicate<Object> that will be applied to every entity instance during indexing process.
String	getIndexName()	Gets name of this index
IndexMappingConfiguration	getMapping()	Gets mapping of this index

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

entityClass

protected final Class<?> entityClass

affectedEntityClasses

protected final Set<Class<?>> affectedEntityClasses

indexName

protected final String indexName

mapping

protected final IndexMappingConfiguration mapping

indexablePredicate

protected final Predicate<Object> indexablePredicate

extendedSearchSettings

protected final ExtendedSearchSettings extendedSearchSettings

Constructor Details

IndexConfiguration

public IndexConfiguration(String entityName,
 Class<?> entityClass,
 String indexName,
 IndexMappingConfiguration mapping,
 Set<Class<?>> affectedEntityClasses,
 Predicate<Object> indexablePredicate,
 ExtendedSearchSettings extendedSearchSettings)

Method Details

getEntityName

public String getEntityName()

Gets name of entity indexed in this index

Returns:

entity name

getEntityClass

public Class<?> getEntityClass()

Gets java class of entity indexed in this index

Returns:

java class

getIndexName

public String getIndexName()

Gets name of this index

Returns:

index name

getMapping

public IndexMappingConfiguration getMapping()

Gets mapping of this index

Returns:

mapping configuration

getAffectedEntityClasses

public Set<Class<?>> getAffectedEntityClasses()

Gets java classes of all entities presented in indexed properties. Transitive entities are included too.

Returns:

set of java classes

getIndexablePredicate

public Predicate<Object> getIndexablePredicate()

Gets Predicate<Object> that will be applied to every entity instance during indexing process. Only instances passed the predicate check will be indexed. Predicate is not used during deletion process.

Returns:

indexable predicate

getExtendedSearchSettings

public ExtendedSearchSettings getExtendedSearchSettings()