org.craftercms.search.batch.impl

Class AbstractBatchIndexer

java.lang.Object

org.craftercms.search.batch.impl.AbstractBatchIndexer

All Implemented Interfaces:

BatchIndexer

Direct Known Subclasses:

BinaryFileBatchIndexer, BinaryFileWithMetadataBatchIndexer, XmlFileBatchIndexer

public abstract class AbstractBatchIndexer
extends Object
implements BatchIndexer

Created by alfonsovasquez on 2/6/16.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	excludeFileNamePatterns
protected List<String>	includeFileNamePatterns
protected org.craftercms.search.service.SearchService	searchService

Constructor Summary

Constructors

Constructor and Description
AbstractBatchIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doDelete(String indexId, String siteName, String id)
protected abstract boolean	doSingleFileUpdate(String indexId, String siteName, String rootFolder, String fileName, boolean delete)
protected boolean	doUpdate(String indexId, String siteName, String id, String xml)
protected boolean	doUpdateFile(String indexId, String siteName, String id, File file)
protected boolean	doUpdateFile(String indexId, String siteName, String id, File file, Map<String,List<String>> additionalFields)
protected String	getIndexNameStr(String indexId)
protected String	getSiteBasedFileName(String siteName, String fileName)
protected boolean	include(String fileName)
void	setExcludeFileNamePatterns(List<String> excludeFileNamePatterns)
void	setIncludeFileNamePatterns(List<String> includeFileNamePatterns)
void	setSearchService(org.craftercms.search.service.SearchService searchService)
int	updateIndex(String indexId, String siteName, String rootFolder, List<String> fileNames, boolean delete) Updates the specified search index with the given batch of files.

Methods inherited from class java.lang.Object

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

Field Detail

searchService

protected org.craftercms.search.service.SearchService searchService

includeFileNamePatterns

protected List<String> includeFileNamePatterns

excludeFileNamePatterns

protected List<String> excludeFileNamePatterns

Constructor Detail

AbstractBatchIndexer

public AbstractBatchIndexer()

Method Detail

setSearchService

public void setSearchService(org.craftercms.search.service.SearchService searchService)

setIncludeFileNamePatterns

public void setIncludeFileNamePatterns(List<String> includeFileNamePatterns)

setExcludeFileNamePatterns

public void setExcludeFileNamePatterns(List<String> excludeFileNamePatterns)

updateIndex

public int updateIndex(String indexId,
              String siteName,
              String rootFolder,
              List<String> fileNames,
              boolean delete)
                throws BatchIndexingException

Description copied from interface: BatchIndexer

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

Specified by:

updateIndex in interface BatchIndexer

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

doUpdate

protected boolean doUpdate(String indexId,
               String siteName,
               String id,
               String xml)
                    throws org.craftercms.search.exception.SearchException

Throws:

org.craftercms.search.exception.SearchException

doUpdateFile

protected boolean doUpdateFile(String indexId,
                   String siteName,
                   String id,
                   File file)
                        throws org.craftercms.search.exception.SearchException

Throws:

org.craftercms.search.exception.SearchException

doUpdateFile

protected boolean doUpdateFile(String indexId,
                   String siteName,
                   String id,
                   File file,
                   Map<String,List<String>> additionalFields)
                        throws org.craftercms.search.exception.SearchException

Throws:

org.craftercms.search.exception.SearchException

doDelete

protected boolean doDelete(String indexId,
               String siteName,
               String id)
                    throws org.craftercms.search.exception.SearchException

Throws:

org.craftercms.search.exception.SearchException

getSiteBasedFileName

protected String getSiteBasedFileName(String siteName,
                          String fileName)

getIndexNameStr

protected String getIndexNameStr(String indexId)

include

protected boolean include(String fileName)

doSingleFileUpdate

protected abstract boolean doSingleFileUpdate(String indexId,
                         String siteName,
                         String rootFolder,
                         String fileName,
                         boolean delete)
                                       throws BatchIndexingException

Throws:

BatchIndexingException