com.broadleafcommerce.advancedcms.search

Class AbstractCollectionPageSearchProcessor

java.lang.Object

com.broadleafcommerce.advancedcms.search.AbstractCollectionPageSearchProcessor

All Implemented Interfaces:

CollectionPageSearchProcessor

Direct Known Subclasses:

DefaultCollectionPageSearchProcessor

public abstract class AbstractCollectionPageSearchProcessor
extends Object
implements CollectionPageSearchProcessor

This class is a useful starting point for Search Processors that need to retrieve all of the collection pages of a given type while applying the rules they are attached to.

Author:

Jerry Ocanas (jocanas), Phillip Verheyden (phillipuniverse)

See Also:

DefaultCollectionPageSearchProcessor}

Field Summary

Fields

Modifier and Type	Field and Description
protected AdvancedPageService	advancedPageService
protected static String	BLC_RULE_MAP_PARAM
protected static org.apache.commons.logging.Log	LOG
protected static String	REQUEST_DTO

Constructor Summary

Constructors

Constructor and Description
AbstractCollectionPageSearchProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Object>	buildMvelParameters(javax.servlet.http.HttpServletRequest request) MVEL is used to process the content targeting rules.
protected SearchResult	constructSearchResultObject(List<org.broadleafcommerce.openadmin.dto.FilterAndSortCriteria> originalCriteria, List<org.broadleafcommerce.common.page.dto.PageDTO> results) Convenience method for constructing the return object.
protected List<org.broadleafcommerce.common.page.dto.PageDTO>	fetchAllPagesAssociatedWithType(com.broadleafcommerce.theme.domain.page.PageType type) Fetches all the Structured Content of the StructuredContentType passed in.
List<org.broadleafcommerce.common.page.dto.PageDTO>	sortResults(List<org.broadleafcommerce.common.page.dto.PageDTO> pageList, List<org.broadleafcommerce.openadmin.dto.FilterAndSortCriteria> criteriaList) Returns a new, sorted list of PageDTO based on the criteria list being based in.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.advancedcms.search.CollectionPageSearchProcessor

search

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

REQUEST_DTO

protected static final String REQUEST_DTO

See Also:

Constant Field Values

BLC_RULE_MAP_PARAM

protected static final String BLC_RULE_MAP_PARAM

See Also:

Constant Field Values

advancedPageService

protected AdvancedPageService advancedPageService

Constructor Detail

AbstractCollectionPageSearchProcessor

public AbstractCollectionPageSearchProcessor()

Method Detail

constructSearchResultObject

protected SearchResult constructSearchResultObject(List<org.broadleafcommerce.openadmin.dto.FilterAndSortCriteria> originalCriteria,
                                       List<org.broadleafcommerce.common.page.dto.PageDTO> results)

Convenience method for constructing the return object. This will also take care of sorting the list of PageDTO that is passed in.

Parameters:

originalQuery -

results -

Returns:

fetchAllPagesAssociatedWithType

protected List<org.broadleafcommerce.common.page.dto.PageDTO> fetchAllPagesAssociatedWithType(com.broadleafcommerce.theme.domain.page.PageType type)

Fetches all the Structured Content of the StructuredContentType passed in. The results are filtered by the rules of the given Structured Content item.

Parameters:

type -

Returns:

sortResults

public List<org.broadleafcommerce.common.page.dto.PageDTO> sortResults(List<org.broadleafcommerce.common.page.dto.PageDTO> pageList,
                                                              List<org.broadleafcommerce.openadmin.dto.FilterAndSortCriteria> criteriaList)

Returns a new, sorted list of PageDTO based on the criteria list being based in. The original pageList parameter is left unsorted.

Parameters:

pageList - the list of content to sort

criteriaList - the criteria that contains the properties to sort on as well as their sort directions

Returns:

a new list based on pageList but sorted according to criteriaList

buildMvelParameters

protected Map<String,Object> buildMvelParameters(javax.servlet.http.HttpServletRequest request)

MVEL is used to process the content targeting rules.

Parameters:

request -

Returns: