Package io.jmix.search.index

Interface EntityIndexer

All Known Implementing Classes:
BaseEntityIndexer, ElasticsearchEntityIndexer, OpenSearchEntityIndexer
public interface EntityIndexer
Provides functionality for direct documents indexing.

  • Method Details

    • index

      IndexResult index(Object entityInstance)
      Stores provided entity instance to index.
      Parameters:
      entityInstance - instance
      Returns:
      IndexResult

    • indexCollection

      IndexResult indexCollection(Collection<Object> entityInstances)
      Stores provided entity instances to index.
      Parameters:
      entityInstances - instances
      Returns:
      IndexResult

    • indexByEntityId

      IndexResult indexByEntityId(Id<?> entityId)
      Stores entity instance to index by provided ID.
      Parameters:
      entityId - ID of entity instance
      Returns:
      IndexResult

    • indexCollectionByEntityIds

      IndexResult indexCollectionByEntityIds(Collection<Id<?>> entityIds)
      Stores entity instances to index by provided IDs.
      Parameters:
      entityIds - IDs of entity instances
      Returns:
      IndexResult

    • delete

      IndexResult delete(Object entityInstance)
      Deletes provided entity instance from index.
      Parameters:
      entityInstance - instance
      Returns:
      IndexResult

    • deleteCollection

      IndexResult deleteCollection(Collection<Object> entityInstances)
      Deletes provided entity instances from index.
      Parameters:
      entityInstances - instances
      Returns:
      IndexResult

    • deleteByEntityId

      IndexResult deleteByEntityId(Id<?> entityId)
      Deletes entity instance from index by provided ID.
      Parameters:
      entityId - ID of entity instance
      Returns:
      IndexResult

    • deleteCollectionByEntityIds

      IndexResult deleteCollectionByEntityIds(Collection<Id<?>> entityIds)
      Deletes entity instances from index by provided IDs.
      Parameters:
      entityIds - IDs of entity instances
      Returns:
      IndexResult