com.broadleafcommerce.advancedcms.search

Class ArchiveCollectionPageSearchProcessor

java.lang.Object

com.broadleafcommerce.advancedcms.search.AbstractCollectionPageSearchProcessor

com.broadleafcommerce.advancedcms.search.DefaultCollectionPageSearchProcessor

com.broadleafcommerce.advancedcms.search.ArchiveCollectionPageSearchProcessor

All Implemented Interfaces:

CollectionPageSearchProcessor

@Component(value="blArchiveCollectionPageSearchProcessor")
public class ArchiveCollectionPageSearchProcessor
extends DefaultCollectionPageSearchProcessor

Similar to DefaultCollectionPageSearchProcessor except that it assumes that the content property value is a Date. Additionally, this processor will only execute for the restrictFilterProprty that matches the filterProperty, which. This processor was intended to be used to filter content that was created within a month. A common use case is for filtering blog posts by day, month, or year.

Author:

Joseph Fridye (jfridye)

See Also:

DefaultCollectionPageSearchProcessor}

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dayFormat
protected String	monthFormat
protected String	restrictFilterProperty
protected String	yearFormat

Fields inherited from class com.broadleafcommerce.advancedcms.search.DefaultCollectionPageSearchProcessor

LOG

Fields inherited from class com.broadleafcommerce.advancedcms.search.AbstractCollectionPageSearchProcessor

advancedPageService, BLC_RULE_MAP_PARAM, REQUEST_DTO

Constructor Summary

Constructors

Constructor and Description
ArchiveCollectionPageSearchProcessor()

Method Summary

Modifier and Type	Method and Description
String	getDayFormat()
String	getMonthFormat()
String	getRestrictFilterProperty() Gets the restricted filter properties
String	getYearFormat()
boolean	isMatch(org.broadleafcommerce.common.page.dto.PageDTO dto, String filterProperty, Object contentValue, String filterValue)
void	setDayFormat(String dayFormat)
void	setMonthFormat(String monthFormat)
void	setRestrictFilterProperty(String restrictFilterProperty) Sets the restricted filter properties
void	setYearFormat(String yearFormat)

Methods inherited from class com.broadleafcommerce.advancedcms.search.DefaultCollectionPageSearchProcessor

search

Methods inherited from class com.broadleafcommerce.advancedcms.search.AbstractCollectionPageSearchProcessor

buildMvelParameters, constructSearchResultObject, fetchAllPagesAssociatedWithType, sortResults

Methods inherited from class java.lang.Object

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

Field Detail

dayFormat

protected String dayFormat

monthFormat

protected String monthFormat

yearFormat

protected String yearFormat

restrictFilterProperty

protected String restrictFilterProperty

Constructor Detail

ArchiveCollectionPageSearchProcessor

public ArchiveCollectionPageSearchProcessor()

Method Detail

isMatch

public boolean isMatch(org.broadleafcommerce.common.page.dto.PageDTO dto,
                       String filterProperty,
                       Object contentValue,
                       String filterValue)

Overrides:

isMatch in class DefaultCollectionPageSearchProcessor

getRestrictFilterProperty

public String getRestrictFilterProperty()

Gets the restricted filter properties

setRestrictFilterProperty

public void setRestrictFilterProperty(String restrictFilterProperty)

Sets the restricted filter properties

getDayFormat

public String getDayFormat()

setDayFormat

public void setDayFormat(String dayFormat)

getMonthFormat

public String getMonthFormat()

setMonthFormat

public void setMonthFormat(String monthFormat)

getYearFormat

public String getYearFormat()

setYearFormat

public void setYearFormat(String yearFormat)