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

Base class for BatchIndexers. Basically sub-classes only need to provide the processing of each of the files to be indexed.

Author:

avasquez

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 void	doDelete(String indexId, String siteName, String id, IndexingStatus status)
protected abstract void	doSingleFileUpdate(String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String path, boolean delete, IndexingStatus status)
protected void	doUpdate(String indexId, String siteName, String id, String xml, IndexingStatus status)
protected void	doUpdateContent(String indexId, String siteName, String id, org.craftercms.core.service.Content content, IndexingStatus status)
protected void	doUpdateContent(String indexId, String siteName, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields, IndexingStatus status)
protected String	getIndexNameStr(String indexId)
protected String	getSiteBasedPath(String siteName, String path)
protected boolean	include(String fileName)
void	setExcludeFileNamePatterns(List<String> excludeFileNamePatterns)
void	setIncludeFileNamePatterns(List<String> includeFileNamePatterns)
void	setSearchService(org.craftercms.search.service.SearchService searchService)
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.

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 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

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

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

doUpdate

protected void doUpdate(String indexId,
            String siteName,
            String id,
            String xml,
            IndexingStatus status)

doUpdateContent

protected void doUpdateContent(String indexId,
                   String siteName,
                   String id,
                   org.craftercms.core.service.Content content,
                   IndexingStatus status)
                        throws IOException

Throws:

IOException

doUpdateContent

protected void doUpdateContent(String indexId,
                   String siteName,
                   String id,
                   org.craftercms.core.service.Content content,
                   Map<String,List<String>> additionalFields,
                   IndexingStatus status)
                        throws IOException

Throws:

IOException

doDelete

protected void doDelete(String indexId,
            String siteName,
            String id,
            IndexingStatus status)

getSiteBasedPath

protected String getSiteBasedPath(String siteName,
                      String path)

getIndexNameStr

protected String getIndexNameStr(String indexId)

include

protected boolean include(String fileName)

doSingleFileUpdate

protected abstract void doSingleFileUpdate(String indexId,
                      String siteName,
                      org.craftercms.core.service.ContentStoreService contentStoreService,
                      org.craftercms.core.service.Context context,
                      String path,
                      boolean delete,
                      IndexingStatus status)
                                    throws Exception

Throws:

Exception