org.craftercms.search.batch

Interface BatchIndexer

All Known Implementing Classes:

AbstractBatchIndexer, BinaryFileBatchIndexer, BinaryFileWithMetadataBatchIndexer, XmlFileBatchIndexer

public interface BatchIndexer

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

Author:

avasquez

Method Summary

Methods

Modifier and Type	Method and Description
void	updateIndex(String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, List<String> paths, boolean delete, IndexingStatus status) Updates the specified search index with the given batch of files.

Method Detail

updateIndex

void updateIndex(String indexId,
               String siteName,
               org.craftercms.core.service.ContentStoreService contentStoreService,
               org.craftercms.core.service.Context context,
               List<String> paths,
               boolean delete,
               IndexingStatus status)
                 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

paths - the paths in the content store of the files to index

delete - if the given files should be deleted from the index, otherwise they're added

status - status object used to track index updates and deletes

Throws:

BatchIndexingException