org.craftercms.search.batch.impl

Class BinaryFileWithMetadataBatchIndexer

java.lang.Object

org.craftercms.search.batch.impl.BinaryFileWithMetadataBatchIndexer

All Implemented Interfaces:

BatchIndexer

public class BinaryFileWithMetadataBatchIndexer
extends Object
implements BatchIndexer

BatchIndexer that tries to match binary files with metadata files. Right now, a metadata file can reference several binary files. Also, this indexer supports the concept of "child" binaries, where the parent is the metadata file and the binary file only exists in the index as long as the metadata file exists and it references the binary.

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>	childBinaryPathPatterns
static String	DEFAULT_LOCAL_ID_FIELD_NAME
static String	DEFAULT_METADATA_PATH_FIELD_NAME
protected List<String>	excludeMetadataProperties Deprecated.
protected List<String>	excludePropertyPatterns
protected List<String>	includePropertyPatterns
protected org.craftercms.core.processors.ItemProcessor	itemProcessor
protected String	localIdFieldName
protected String	metadataPathFieldName
protected List<String>	metadataPathPatterns
protected List<String>	referenceXPaths

Constructor Summary

Constructors

Constructor and Description
BinaryFileWithMetadataBatchIndexer()

Method Summary

Modifier and Type	Method and Description
protected void	doDeletes(String indexId, String siteName, org.craftercms.search.service.SearchService searchService, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, List<String> deletePaths, UpdateStatus updateStatus)
protected void	doUpdates(String indexId, String siteName, org.craftercms.search.service.SearchService searchService, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, List<String> updatePaths, UpdateStatus updateStatus)
protected org.springframework.util.MultiValueMap<String,String>	extractMetadata(String path, org.dom4j.Document document)
protected void	extractMetadataFromChildren(org.dom4j.Element element, String key, org.springframework.util.MultiValueMap<String,String> metadata)
protected List<String>	getBinaryFilePaths(org.dom4j.Document document)
protected boolean	isBinary(String path)
protected boolean	isChildBinary(String path)
protected boolean	isMetadata(String path)
protected org.dom4j.Document	loadMetadata(org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String siteName, String metadataPath)
protected List<String>	searchBinaryPathsFromMetadataPath(org.craftercms.search.service.SearchService searchService, String indexId, String siteName, String metadataPath)
protected String	searchMetadataPathFromBinaryPath(org.craftercms.search.service.SearchService searchService, String indexId, String siteName, String binaryPath)
void	setBinaryPathPatterns(List<String> binaryPathPatterns)
void	setChildBinaryPathPatterns(List<String> childBinaryPathPatterns)
void	setExcludeMetadataProperties(List<String> excludeMetadataProperties) Deprecated.
void	setExcludePropertyPatterns(List<String> excludePropertyPatterns)
void	setIncludePropertyPatterns(List<String> includePropertyPatterns)
void	setItemProcessor(org.craftercms.core.processors.ItemProcessor itemProcessor)
void	setItemProcessors(List<org.craftercms.core.processors.ItemProcessor> itemProcessors)
void	setLocalIdFieldName(String localIdFieldName)
void	setMetadataPathFieldName(String metadataPathFieldName)
void	setMetadataPathPatterns(List<String> metadataPathPatterns)
void	setReferenceXPaths(List<String> referenceXPaths)
protected boolean	shouldIncludeProperty(String name)
protected void	updateBinary(org.craftercms.search.service.SearchService searchService, String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String binaryPath, UpdateStatus updateStatus)
protected void	updateBinaryWithMetadata(org.craftercms.search.service.SearchService searchService, String indexId, String siteName, org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.core.service.Context context, String binaryPath, org.springframework.util.MultiValueMap<String,String> metadata, UpdateStatus updateStatus)
void	updateIndex(org.craftercms.search.service.SearchService searchService, 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 java.lang.Object

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

Field Detail

DEFAULT_METADATA_PATH_FIELD_NAME

public static final String DEFAULT_METADATA_PATH_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_LOCAL_ID_FIELD_NAME

public static final String DEFAULT_LOCAL_ID_FIELD_NAME

See Also:

Constant Field Values

itemProcessor

protected org.craftercms.core.processors.ItemProcessor itemProcessor

metadataPathPatterns

protected List<String> metadataPathPatterns

binaryPathPatterns

protected List<String> binaryPathPatterns

childBinaryPathPatterns

protected List<String> childBinaryPathPatterns

referenceXPaths

protected List<String> referenceXPaths

includePropertyPatterns

protected List<String> includePropertyPatterns

excludePropertyPatterns

protected List<String> excludePropertyPatterns

excludeMetadataProperties

@Deprecated
protected List<String> excludeMetadataProperties

Deprecated.

metadataPathFieldName

protected String metadataPathFieldName

localIdFieldName

protected String localIdFieldName

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)

setChildBinaryPathPatterns

public void setChildBinaryPathPatterns(List<String> childBinaryPathPatterns)

setReferenceXPaths

public void setReferenceXPaths(List<String> referenceXPaths)

setIncludePropertyPatterns

public void setIncludePropertyPatterns(List<String> includePropertyPatterns)

setExcludePropertyPatterns

public void setExcludePropertyPatterns(List<String> excludePropertyPatterns)

setExcludeMetadataProperties

@Deprecated
public void setExcludeMetadataProperties(List<String> excludeMetadataProperties)

Deprecated.

setMetadataPathFieldName

public void setMetadataPathFieldName(String metadataPathFieldName)

setLocalIdFieldName

public void setLocalIdFieldName(String localIdFieldName)

updateIndex

public void updateIndex(org.craftercms.search.service.SearchService searchService,
                        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:

searchService - the search service to use

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

doUpdates

protected void doUpdates(String indexId,
                         String siteName,
                         org.craftercms.search.service.SearchService searchService,
                         org.craftercms.core.service.ContentStoreService contentStoreService,
                         org.craftercms.core.service.Context context,
                         List<String> updatePaths,
                         UpdateStatus updateStatus)

doDeletes

protected void doDeletes(String indexId,
                         String siteName,
                         org.craftercms.search.service.SearchService searchService,
                         org.craftercms.core.service.ContentStoreService contentStoreService,
                         org.craftercms.core.service.Context context,
                         List<String> deletePaths,
                         UpdateStatus updateStatus)

isMetadata

protected boolean isMetadata(String path)

isBinary

protected boolean isBinary(String path)

isChildBinary

protected boolean isChildBinary(String path)

searchBinaryPathsFromMetadataPath

protected List<String> searchBinaryPathsFromMetadataPath(org.craftercms.search.service.SearchService searchService,
                                                         String indexId,
                                                         String siteName,
                                                         String metadataPath)

searchMetadataPathFromBinaryPath

protected String searchMetadataPathFromBinaryPath(org.craftercms.search.service.SearchService searchService,
                                                  String indexId,
                                                  String siteName,
                                                  String binaryPath)

loadMetadata

protected org.dom4j.Document loadMetadata(org.craftercms.core.service.ContentStoreService contentStoreService,
                                          org.craftercms.core.service.Context context,
                                          String siteName,
                                          String metadataPath)

getBinaryFilePaths

protected List<String> getBinaryFilePaths(org.dom4j.Document document)

updateBinaryWithMetadata

protected void updateBinaryWithMetadata(org.craftercms.search.service.SearchService searchService,
                                        String indexId,
                                        String siteName,
                                        org.craftercms.core.service.ContentStoreService contentStoreService,
                                        org.craftercms.core.service.Context context,
                                        String binaryPath,
                                        org.springframework.util.MultiValueMap<String,String> metadata,
                                        UpdateStatus updateStatus)

updateBinary

protected void updateBinary(org.craftercms.search.service.SearchService searchService,
                            String indexId,
                            String siteName,
                            org.craftercms.core.service.ContentStoreService contentStoreService,
                            org.craftercms.core.service.Context context,
                            String binaryPath,
                            UpdateStatus updateStatus)

extractMetadata

protected org.springframework.util.MultiValueMap<String,String> extractMetadata(String path,
                                                                                org.dom4j.Document document)

extractMetadataFromChildren

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

shouldIncludeProperty

protected boolean shouldIncludeProperty(String name)