org.craftercms.search.batch

Interface BatchIndexer

All Known Implementing Classes:

AbstractBatchIndexer, BinaryFileBatchIndexer, BinaryFileWithMetadataBatchIndexer, FlattenedXmlFileBatchIndexer, 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
int	updateIndex(String indexId, String siteName, String rootFolder, List<String> fileNames, boolean delete) Updates the specified search index with the given batch of files.

Method Detail

updateIndex

int updateIndex(String indexId,
              String siteName,
              String rootFolder,
              List<String> fileNames,
              boolean delete)
                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

rootFolder - the root folder in the file system where the files are

fileNames - the names or paths of the files to update/delete, relative to the root folder

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

Returns:

the number of files that where actually added/deleted

Throws:

BatchIndexingException