org.craftercms.search.batch.impl

Class AbstractXmlFileBatchIndexer

java.lang.Object

org.craftercms.search.metadata.impl.AbstractMetadataCollector

org.craftercms.search.batch.impl.AbstractBatchIndexer

org.craftercms.search.batch.impl.AbstractXmlFileBatchIndexer

All Implemented Interfaces:

BatchIndexer

Direct Known Subclasses:

ElasticsearchXmlFileBatchIndexer, XmlFileBatchIndexer

public abstract class AbstractXmlFileBatchIndexer
extends AbstractBatchIndexer

BatchIndexer that updates/deletes XML files from a search index.

Author:

avasquez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractXmlFileBatchIndexer.EmptyContent

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DEFAULT_INCLUDE_FILENAME_PATTERNS
protected org.craftercms.core.processors.ItemProcessor	itemProcessor

Fields inherited from class org.craftercms.search.batch.impl.AbstractBatchIndexer

excludePathPatterns, includePathPatterns

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

metadataExtractors

Constructor Summary

Constructors

Constructor and Description
AbstractXmlFileBatchIndexer()

Method Summary

Modifier and Type	Method and Description
protected String	documentToString(org.dom4j.Document document)
protected abstract void	doDelete(String indexId, String siteName, String path, UpdateStatus updateStatus)
protected 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 abstract void	doUpdate(String indexId, String siteName, String path, String xml, UpdateDetail updateDetail, UpdateStatus updateStatus, Map<String,String> metadata)
protected String	processXml(String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String path)
void	setItemProcessor(org.craftercms.core.processors.ItemProcessor itemProcessor)
void	setItemProcessors(List<org.craftercms.core.processors.ItemProcessor> itemProcessors)

Methods inherited from class org.craftercms.search.batch.impl.AbstractBatchIndexer

include, setExcludePathPatterns, setIncludePathPatterns, updateIndex

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

DEFAULT_INCLUDE_FILENAME_PATTERNS

public static final List<String> DEFAULT_INCLUDE_FILENAME_PATTERNS

itemProcessor

protected org.craftercms.core.processors.ItemProcessor itemProcessor

Constructor Detail

AbstractXmlFileBatchIndexer

public AbstractXmlFileBatchIndexer()

Method Detail

setItemProcessor

public void setItemProcessor(org.craftercms.core.processors.ItemProcessor itemProcessor)

setItemProcessors

public void setItemProcessors(List<org.craftercms.core.processors.ItemProcessor> itemProcessors)

doSingleFileUpdate

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

Specified by:

doSingleFileUpdate in class AbstractBatchIndexer

doDelete

protected abstract void doDelete(String indexId,
                                 String siteName,
                                 String path,
                                 UpdateStatus updateStatus)

doUpdate

protected abstract void doUpdate(String indexId,
                                 String siteName,
                                 String path,
                                 String xml,
                                 UpdateDetail updateDetail,
                                 UpdateStatus updateStatus,
                                 Map<String,String> metadata)

processXml

protected String processXml(String siteName,
                            org.craftercms.core.service.ContentStoreService contentStoreService,
                            org.craftercms.core.service.Context context,
                            String path)
                     throws org.craftercms.core.exception.CrafterException

Throws:

org.craftercms.core.exception.CrafterException

documentToString

protected String documentToString(org.dom4j.Document document)