Package org.craftercms.search.batch

Interface BatchIndexer

All Known Implementing Classes:

AbstractBatchIndexer, AbstractBinaryFileBatchIndexer, AbstractBinaryFileWithMetadataBatchIndexer, AbstractXmlFileBatchIndexer, AuthoringOpenSearchBinaryFileWithMetadataBatchIndexer, OpenSearchBinaryFileBatchIndexer, OpenSearchBinaryFileWithMetadataBatchIndexer, OpenSearchXmlFileBatchIndexer

public interface BatchIndexer

Classes that implement this interface update or delete batches of files from a specified search index.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
void	updateIndex(String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, UpdateSet updateSet, UpdateStatus updateStatus)	Updates the specified search index with the given batch of files.

Method Details

updateIndex

void updateIndex(String indexId,
 String siteName,
 org.craftercms.core.service.ContentStoreService contentStoreService,
 org.craftercms.core.service.Context context,
 UpdateSet updateSet,
 UpdateStatus updateStatus)
          throws BatchIndexingException

Updates the specified search index with the given batch of files.

Parameters:

indexId - the ID of the index, or null to use a default index

siteName - the name of the site the files belong to

contentStoreService - the content store service used to retrieve the files and content to index

context - the context of the file store being used

updateSet - the set of files to update/delete

updateStatus - status object used to track index updates and deletes

Throws:

BatchIndexingException