org.craftercms.search.batch.impl

Class AbstractBatchIndexer

java.lang.Object

org.craftercms.search.metadata.impl.AbstractMetadataCollector

org.craftercms.search.batch.impl.AbstractBatchIndexer

All Implemented Interfaces:

BatchIndexer

Direct Known Subclasses:

AbstractBinaryFileBatchIndexer, AbstractXmlFileBatchIndexer

public abstract class AbstractBatchIndexer
extends AbstractMetadataCollector
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>	excludePathPatterns
protected List<String>	includePathPatterns

Fields inherited from class org.craftercms.search.metadata.impl.AbstractMetadataCollector

metadataExtractors

Constructor Summary

Constructors

Constructor and Description
AbstractBatchIndexer()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doSingleFileUpdate(String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String path, boolean delete, UpdateDetail updateDetail, UpdateStatus updateStatus, Map<String,String> metadata)
protected boolean	include(String path)
void	setExcludePathPatterns(List<String> excludePathPatterns)
void	setIncludePathPatterns(List<String> includePathPatterns)
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.

Methods inherited from class org.craftercms.search.metadata.impl.AbstractMetadataCollector

collectMetadata, setMetadataExtractors

Methods inherited from class java.lang.Object

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

Field Detail

includePathPatterns

protected List<String> includePathPatterns

excludePathPatterns

protected List<String> excludePathPatterns

Constructor Detail

AbstractBatchIndexer

public AbstractBatchIndexer()

Method Detail

setIncludePathPatterns

public void setIncludePathPatterns(List<String> includePathPatterns)

setExcludePathPatterns

public void setExcludePathPatterns(List<String> excludePathPatterns)

updateIndex

public void updateIndex(String indexId,
                        String siteName,
                        org.craftercms.core.service.ContentStoreService contentStoreService,
                        org.craftercms.core.service.Context context,
                        UpdateSet updateSet,
                        UpdateStatus updateStatus)
                 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

updateSet - the set of files to update/delete

updateStatus - status object used to track index updates and deletes

Throws:

BatchIndexingException

include

protected boolean include(String path)

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,
                                           UpdateDetail updateDetail,
                                           UpdateStatus updateStatus,
                                           Map<String,String> metadata)
                                    throws Exception

Throws:

Exception