org.craftercms.search.batch.impl

Class BinaryFileWithMetadataBatchIndexer

java.lang.Object

org.craftercms.search.batch.impl.AbstractBatchIndexer

org.craftercms.search.batch.impl.BinaryFileWithMetadataBatchIndexer

All Implemented Interfaces:

BatchIndexer

public class BinaryFileWithMetadataBatchIndexer
extends AbstractBatchIndexer

BatchIndexer that tries to match the update/deleted files against a series of metadata/binary path patterns. If a file is matched as metadata, it's is parsed for a reference to it's binary. If one is found, then an update will be issued for the binary file along with the metadata that is extracted from the metadata file, or a delete for the referenced binary file. If the file is matched as binary, then an update/delete is issued without any metadata.

Author:

avasquez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BinaryFileWithMetadataBatchIndexer.EmptyContent

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	binaryPathPatterns
protected List<String>	excludeMetadataProperties
protected org.craftercms.core.processors.ItemProcessor	itemProcessor
protected List<String>	metadataPathPatterns
protected List<String>	referenceXPaths

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

excludeFileNamePatterns, includeFileNamePatterns, searchService

Constructor Summary

Constructors

Constructor and Description
BinaryFileWithMetadataBatchIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
protected 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 Map<String,List<String>>	extractMetadata(org.dom4j.Document document)
protected void	extractMetadataFromChildren(org.dom4j.Element element, String key, org.springframework.util.MultiValueMap<String,String> metadata)
protected String	getBinaryFilePath(org.dom4j.Document document)
protected boolean	isBinaryFile(String path)
protected boolean	isMetadataFile(String path)
void	setBinaryPathPatterns(List<String> binaryPathPatterns)
void	setExcludeMetadataProperties(List<String> excludeMetadataProperties)
void	setItemProcessor(org.craftercms.core.processors.ItemProcessor itemProcessor)
void	setItemProcessors(List<org.craftercms.core.processors.ItemProcessor> itemProcessors)
void	setMetadataPathPatterns(List<String> metadataPathPatterns)
void	setReferenceXPaths(List<String> referenceXPaths)

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

doDelete, doUpdate, doUpdateContent, doUpdateContent, getIndexNameStr, getSiteBasedPath, include, setExcludeFileNamePatterns, setIncludeFileNamePatterns, setSearchService, updateIndex

Methods inherited from class java.lang.Object

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

Field Detail

itemProcessor

protected org.craftercms.core.processors.ItemProcessor itemProcessor

metadataPathPatterns

protected List<String> metadataPathPatterns

binaryPathPatterns

protected List<String> binaryPathPatterns

referenceXPaths

protected List<String> referenceXPaths

excludeMetadataProperties

protected List<String> excludeMetadataProperties

Constructor Detail

BinaryFileWithMetadataBatchIndexer

public BinaryFileWithMetadataBatchIndexer()

Method Detail

setItemProcessor

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

setItemProcessors

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

setMetadataPathPatterns

public void setMetadataPathPatterns(List<String> metadataPathPatterns)

setBinaryPathPatterns

public void setBinaryPathPatterns(List<String> binaryPathPatterns)

setReferenceXPaths

public void setReferenceXPaths(List<String> referenceXPaths)

setExcludeMetadataProperties

public void setExcludeMetadataProperties(List<String> excludeMetadataProperties)

doSingleFileUpdate

protected 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

Specified by:

doSingleFileUpdate in class AbstractBatchIndexer

Throws:

Exception

isMetadataFile

protected boolean isMetadataFile(String path)

isBinaryFile

protected boolean isBinaryFile(String path)

getBinaryFilePath

protected String getBinaryFilePath(org.dom4j.Document document)

extractMetadata

protected Map<String,List<String>> extractMetadata(org.dom4j.Document document)

extractMetadataFromChildren

protected void extractMetadataFromChildren(org.dom4j.Element element,
                               String key,
                               org.springframework.util.MultiValueMap<String,String> metadata)