Class IndexConfiguration

java.lang.Object
io.jmix.search.index.IndexConfiguration

public class IndexConfiguration extends Object
Contains configuration of index related to some entity
  • 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

  • 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()