Package io.jmix.search.index.impl

Class BaseEntityIndexer

java.lang.Object

io.jmix.search.index.impl.BaseEntityIndexer

All Implemented Interfaces:

EntityIndexer

Direct Known Subclasses:

ElasticsearchEntityIndexer, OpenSearchEntityIndexer

public abstract class BaseEntityIndexer
extends Object
implements EntityIndexer

Provides non-platform-specific functionality. Interaction with indexes is performed in platform-specific implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	BaseEntityIndexer.IndexDocumentData

Field Summary

Fields

Modifier and Type	Field	Description
protected final UnconstrainedDataManager	dataManager
protected final FetchPlans	fetchPlans
protected final IdSerialization	idSerialization
protected final IndexConfigurationManager	indexConfigurationManager
protected final IndexStateRegistry	indexStateRegistry
protected final Metadata	metadata
protected final MetadataTools	metadataTools
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final SearchProperties	searchProperties

Constructor Summary

Constructors

Constructor	Description
BaseEntityIndexer(UnconstrainedDataManager dataManager, FetchPlans fetchPlans, IndexConfigurationManager indexConfigurationManager, Metadata metadata, IdSerialization idSerialization, IndexStateRegistry indexStateRegistry, MetadataTools metadataTools, SearchProperties searchProperties)

Method Summary

Modifier and Type	Method	Description
protected void	addFieldValueToEntityIndexContent(com.fasterxml.jackson.databind.node.ObjectNode entityIndexContent, MappingFieldDescriptor field, Object entity)
protected FetchPlan	createFetchPlan(IndexConfiguration indexConfiguration)
protected com.fasterxml.jackson.databind.node.ObjectNode	createObjectNodeForField(String key, com.fasterxml.jackson.databind.JsonNode value)
IndexResult	delete(Object entityInstance)	Deletes provided entity instance from index.
IndexResult	deleteByEntityId(Id<?> entityId)	Deletes entity instance from index by provided ID.
protected abstract IndexResult	deleteByGroupedDocIds(Map<IndexConfiguration,Collection<String>> groupedDocIds)
protected IndexResult	deleteByGroupedIndexIdsInternal(Map<IndexConfiguration,Collection<String>> groupedIndexIds)
IndexResult	deleteCollection(Collection<Object> entityInstances)	Deletes provided entity instances from index.
IndexResult	deleteCollectionByEntityIds(Collection<Id<?>> entityIds)	Deletes entity instances from index by provided IDs.
protected BaseEntityIndexer.IndexDocumentData	generateIndexDocument(IndexConfiguration indexConfiguration, Object instance)
IndexResult	index(Object entityInstance)	Stores provided entity instance to index.
IndexResult	indexByEntityId(Id<?> entityId)	Stores entity instance to index by provided ID.
IndexResult	indexCollection(Collection<Object> entityInstances)	Stores provided entity instances to index.
IndexResult	indexCollectionByEntityIds(Collection<Id<?>> entityIds)	Stores entity instances to index by provided IDs.
protected abstract IndexResult	indexDocuments(List<BaseEntityIndexer.IndexDocumentData> documents)
protected IndexResult	indexGroupedInstances(Map<IndexConfiguration,Collection<Object>> groupedInstances)
protected void	merge(com.fasterxml.jackson.databind.JsonNode toBeMerged, com.fasterxml.jackson.databind.JsonNode mergedInTo)
protected Map<IndexConfiguration,Collection<String>>	prepareIndexIdsByEntityIds(Collection<Id<?>> entityIds)
protected Map<IndexConfiguration,Collection<String>>	prepareIndexIdsByEntityInstances(Collection<Object> instances)
protected Map<IndexConfiguration,Collection<Object>>	prepareInstancesForIndexing(Collection<Object> instances)
protected Map<IndexConfiguration,Collection<Object>>	prepareInstancesForIndexingByIds(Collection<Id<?>> entityIds)
protected Map<IndexConfiguration,Collection<Object>>	reloadEntityInstances(Map<MetaClass,List<Object>> idsGroupedByMetaClass)
protected void	updateArray(com.fasterxml.jackson.databind.JsonNode valueToBePlaced, Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> toBeMerged)
protected void	updateObject(com.fasterxml.jackson.databind.JsonNode mergeInTo, com.fasterxml.jackson.databind.node.ValueNode valueToBePlaced, Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> toBeMerged)

Methods inherited from class java.lang.Object

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

Field Details

dataManager

protected final UnconstrainedDataManager dataManager

fetchPlans

protected final FetchPlans fetchPlans

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

metadata

protected final Metadata metadata

idSerialization

protected final IdSerialization idSerialization

indexStateRegistry

protected final IndexStateRegistry indexStateRegistry

metadataTools

protected final MetadataTools metadataTools

searchProperties

protected final SearchProperties searchProperties

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

BaseEntityIndexer

public BaseEntityIndexer(UnconstrainedDataManager dataManager,
 FetchPlans fetchPlans,
 IndexConfigurationManager indexConfigurationManager,
 Metadata metadata,
 IdSerialization idSerialization,
 IndexStateRegistry indexStateRegistry,
 MetadataTools metadataTools,
 SearchProperties searchProperties)

Method Details

index

public IndexResult index(Object entityInstance)

Description copied from interface: EntityIndexer

Stores provided entity instance to index.

Specified by:

index in interface EntityIndexer

Parameters:

entityInstance - instance

Returns:

IndexResult

indexCollection

public IndexResult indexCollection(Collection<Object> entityInstances)

Description copied from interface: EntityIndexer

Stores provided entity instances to index.

Specified by:

indexCollection in interface EntityIndexer

Parameters:

entityInstances - instances

Returns:

IndexResult

indexByEntityId

public IndexResult indexByEntityId(Id<?> entityId)

Description copied from interface: EntityIndexer

Stores entity instance to index by provided ID.

Specified by:

indexByEntityId in interface EntityIndexer

Parameters:

entityId - ID of entity instance

Returns:

IndexResult

indexCollectionByEntityIds

public IndexResult indexCollectionByEntityIds(Collection<Id<?>> entityIds)

Description copied from interface: EntityIndexer

Stores entity instances to index by provided IDs.

Specified by:

indexCollectionByEntityIds in interface EntityIndexer

Parameters:

entityIds - IDs of entity instances

Returns:

IndexResult

delete

public IndexResult delete(Object entityInstance)

Description copied from interface: EntityIndexer

Deletes provided entity instance from index.

Specified by:

delete in interface EntityIndexer

Parameters:

entityInstance - instance

Returns:

IndexResult

deleteCollection

public IndexResult deleteCollection(Collection<Object> entityInstances)

Description copied from interface: EntityIndexer

Deletes provided entity instances from index.

Specified by:

deleteCollection in interface EntityIndexer

Parameters:

entityInstances - instances

Returns:

IndexResult

deleteByEntityId

public IndexResult deleteByEntityId(Id<?> entityId)

Description copied from interface: EntityIndexer

Deletes entity instance from index by provided ID.

Specified by:

deleteByEntityId in interface EntityIndexer

Parameters:

entityId - ID of entity instance

Returns:

IndexResult

deleteCollectionByEntityIds

public IndexResult deleteCollectionByEntityIds(Collection<Id<?>> entityIds)

Description copied from interface: EntityIndexer

Deletes entity instances from index by provided IDs.

Specified by:

deleteCollectionByEntityIds in interface EntityIndexer

Parameters:

entityIds - IDs of entity instances

Returns:

IndexResult

indexDocuments

protected abstract IndexResult indexDocuments(List<BaseEntityIndexer.IndexDocumentData> documents)

deleteByGroupedDocIds

protected abstract IndexResult deleteByGroupedDocIds(Map<IndexConfiguration,Collection<String>> groupedDocIds)

indexGroupedInstances

protected IndexResult indexGroupedInstances(Map<IndexConfiguration,Collection<Object>> groupedInstances)

deleteByGroupedIndexIdsInternal

protected IndexResult deleteByGroupedIndexIdsInternal(Map<IndexConfiguration,Collection<String>> groupedIndexIds)

prepareInstancesForIndexing

protected Map<IndexConfiguration,Collection<Object>> prepareInstancesForIndexing(Collection<Object> instances)

prepareInstancesForIndexingByIds

protected Map<IndexConfiguration,Collection<Object>> prepareInstancesForIndexingByIds(Collection<Id<?>> entityIds)

prepareIndexIdsByEntityInstances

protected Map<IndexConfiguration,Collection<String>> prepareIndexIdsByEntityInstances(Collection<Object> instances)

prepareIndexIdsByEntityIds

protected Map<IndexConfiguration,Collection<String>> prepareIndexIdsByEntityIds(Collection<Id<?>> entityIds)

reloadEntityInstances

protected Map<IndexConfiguration,Collection<Object>> reloadEntityInstances(Map<MetaClass,List<Object>> idsGroupedByMetaClass)

createFetchPlan

protected FetchPlan createFetchPlan(IndexConfiguration indexConfiguration)

generateIndexDocument

protected BaseEntityIndexer.IndexDocumentData generateIndexDocument(IndexConfiguration indexConfiguration,
 Object instance)

addFieldValueToEntityIndexContent

protected void addFieldValueToEntityIndexContent(com.fasterxml.jackson.databind.node.ObjectNode entityIndexContent,
 MappingFieldDescriptor field,
 Object entity)

createObjectNodeForField

protected com.fasterxml.jackson.databind.node.ObjectNode createObjectNodeForField(String key,
 com.fasterxml.jackson.databind.JsonNode value)

merge

protected void merge(com.fasterxml.jackson.databind.JsonNode toBeMerged,
 com.fasterxml.jackson.databind.JsonNode mergedInTo)

updateArray

protected void updateArray(com.fasterxml.jackson.databind.JsonNode valueToBePlaced,
 Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> toBeMerged)

updateObject

protected void updateObject(com.fasterxml.jackson.databind.JsonNode mergeInTo,
 com.fasterxml.jackson.databind.node.ValueNode valueToBePlaced,
 Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> toBeMerged)