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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	binaryPathPatterns
protected String	charEncoding
protected List<DocumentProcessor>	documentProcessors
protected List<String>	excludeMetadataProperties
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 boolean	doSingleFileUpdate(String indexId, String siteName, String rootFolder, String fileName, boolean delete)
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	getBinaryFileName(org.dom4j.Document document)
protected boolean	isBinaryFile(String filePath)
protected boolean	isMetadataFile(String filePath)
protected org.dom4j.Document	processDocument(org.dom4j.Document document, File file, String root)
void	setBinaryPathPatterns(List<String> binaryPathPatterns)
void	setDocumentProcessors(List<DocumentProcessor> documentProcessors)
void	setExcludeMetadataProperties(List<String> excludeMetadataProperties)
void	setMetadataPathPatterns(List<String> metadataPathPatterns)
void	setReferenceXPaths(List<String> referenceXPaths)

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

doDelete, doUpdate, doUpdateFile, doUpdateFile, getIndexNameStr, getSiteBasedFileName, 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

documentProcessors

protected List<DocumentProcessor> documentProcessors

charEncoding

protected String charEncoding

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

setDocumentProcessors

public void setDocumentProcessors(List<DocumentProcessor> documentProcessors)

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 boolean doSingleFileUpdate(String indexId,
                         String siteName,
                         String rootFolder,
                         String fileName,
                         boolean delete)
                              throws BatchIndexingException

Specified by:

doSingleFileUpdate in class AbstractBatchIndexer

Throws:

BatchIndexingException

isMetadataFile

protected boolean isMetadataFile(String filePath)

isBinaryFile

protected boolean isBinaryFile(String filePath)

getBinaryFileName

protected String getBinaryFileName(org.dom4j.Document document)

processDocument

protected org.dom4j.Document processDocument(org.dom4j.Document document,
                                 File file,
                                 String root)
                                      throws org.dom4j.DocumentException

Throws:

org.dom4j.DocumentException

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)