org.craftercms.cstudio.publishing.processor

Class ReIndexPagesOnComponentUpdateProcessor

java.lang.Object

org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

org.craftercms.cstudio.publishing.processor.ReIndexPagesOnComponentUpdateProcessor

All Implemented Interfaces:

PublishingProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ReIndexPagesOnComponentUpdateProcessor
extends AbstractPublishingProcessor

Scans the created and updated files for component updates, then executes a search query to retrieve the pages that reference the components. This pages are added to a new updated list, which is then passed to the actual search indexing processor (not added to the original updated list since the updates are only for search purposes).

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected PublishingProcessor	actualIndexingProcessor
protected String	componentsRoot
static String	DEFAULT_COMPONENTS_ROOT
static String	DEFAULT_PAGES_QUERY_PATTERN
protected String	defaultIndexIdFormat
protected boolean	ignoreIndexId
protected String	indexId
protected String	pagesQueryPattern
protected org.craftercms.search.service.SearchService	searchService
protected String	siteName

Fields inherited from class org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

name, order

Fields inherited from interface org.craftercms.cstudio.publishing.processor.PublishingProcessor

SITE_NAME_PREVIEW

Constructor Summary

Constructors

Constructor and Description
ReIndexPagesOnComponentUpdateProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addPagesThatIncludeComponentToUpdatedFiles(String indexId, String component, List<String> createdFiles, List<String> updatedFiles)
protected org.craftercms.search.service.Query	createPagesThatIncludeComponentQuery(String componentId)
protected void	doIndexing(PublishedChangeSet changeSet, Map<String,String> parameters, org.craftercms.core.service.Context context, PublishingTarget target)
void	doProcess(PublishedChangeSet changeSet, Map<String,String> parameters, org.craftercms.core.service.Context context, PublishingTarget target) process files published
protected String	getActualIndexId(String siteName)
protected String	getActualSiteId(Map<String,String> parameters)
protected List<String>	getPagesThatIncludeComponent(String indexId, String componentPath)
protected boolean	isBeingUpdated(String path, List<String> createdFiles, List<String> updatedFiles)
protected boolean	isComponent(String path)
void	setActualIndexingProcessor(PublishingProcessor actualIndexingProcessor)
void	setComponentsRoot(String componentsRoot)
void	setDefaultIndexIdFormat(String defaultIndexIdFormat)
void	setIgnoreIndexId(boolean ignoreIndexId)
void	setIndexId(String indexId)
void	setPagesQueryPattern(String pagesQueryPattern)
void	setSearchService(org.craftercms.search.service.SearchService searchService)
void	setSiteName(String siteName)

Methods inherited from class org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

getName, getOrder, setBeanName, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPONENTS_ROOT

public static final String DEFAULT_COMPONENTS_ROOT

See Also:

Constant Field Values

DEFAULT_PAGES_QUERY_PATTERN

public static final String DEFAULT_PAGES_QUERY_PATTERN

See Also:

Constant Field Values

indexId

protected String indexId

defaultIndexIdFormat

protected String defaultIndexIdFormat

ignoreIndexId

protected boolean ignoreIndexId

siteName

protected String siteName

componentsRoot

protected String componentsRoot

pagesQueryPattern

protected String pagesQueryPattern

searchService

protected org.craftercms.search.service.SearchService searchService

actualIndexingProcessor

protected PublishingProcessor actualIndexingProcessor

Constructor Detail

ReIndexPagesOnComponentUpdateProcessor

public ReIndexPagesOnComponentUpdateProcessor()

Method Detail

setIndexId

public void setIndexId(String indexId)

setDefaultIndexIdFormat

public void setDefaultIndexIdFormat(String defaultIndexIdFormat)

setIgnoreIndexId

public void setIgnoreIndexId(boolean ignoreIndexId)

setSiteName

public void setSiteName(String siteName)

setComponentsRoot

public void setComponentsRoot(String componentsRoot)

setPagesQueryPattern

public void setPagesQueryPattern(String pagesQueryPattern)

setSearchService

public void setSearchService(org.craftercms.search.service.SearchService searchService)

setActualIndexingProcessor

public void setActualIndexingProcessor(PublishingProcessor actualIndexingProcessor)

doProcess

public void doProcess(PublishedChangeSet changeSet,
                      Map<String,String> parameters,
                      org.craftercms.core.service.Context context,
                      PublishingTarget target)
               throws PublishingException

Description copied from interface: PublishingProcessor

process files published

Throws:

PublishingException

doIndexing

protected void doIndexing(PublishedChangeSet changeSet,
                          Map<String,String> parameters,
                          org.craftercms.core.service.Context context,
                          PublishingTarget target)
                   throws PublishingException

Throws:

PublishingException

getPagesThatIncludeComponent

protected List<String> getPagesThatIncludeComponent(String indexId,
                                                    String componentPath)

isComponent

protected boolean isComponent(String path)

isBeingUpdated

protected boolean isBeingUpdated(String path,
                                 List<String> createdFiles,
                                 List<String> updatedFiles)

addPagesThatIncludeComponentToUpdatedFiles

protected void addPagesThatIncludeComponentToUpdatedFiles(String indexId,
                                                          String component,
                                                          List<String> createdFiles,
                                                          List<String> updatedFiles)

createPagesThatIncludeComponentQuery

protected org.craftercms.search.service.Query createPagesThatIncludeComponentQuery(String componentId)

getActualSiteId

protected String getActualSiteId(Map<String,String> parameters)

getActualIndexId

protected String getActualIndexId(String siteName)