Package de.hybris.platform.acceleratorstorefrontcommons.controllers.pages

Class AbstractSearchPageController

java.lang.Object

de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

Direct Known Subclasses:

AbstractCategoryPageController, AccountPageController, AccountPageController, AccountReturnsPageController, AccountSavedCartsPageController, AccountStatusController, AccountSummaryPageController, AccountSupportTicketsPageController, AdvanceSearchPageController, BundlePageController, CancelOrderPageController, CancelReturnPageController, ChineseEmailPageController, CustomerCouponsPageController, CustomerListController, InvoiceDocumentController, MyCompanyPageController, MyInterestsPageController, MyQuotesController, MyReplenishmentOrdersController, OrderApprovalController, PickupInStoreController, ReturnOrderPageController, SapDigitalPaymentAccountPaymentDetailsPageController, SapSubscriptionsPageController, SearchPageController, StoreLocatorPageController, VendorIndexPageController, VendorLandingPageController

public abstract class AbstractSearchPageController
extends AbstractPageController

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSearchPageController.SearchResultsData<RESULT>
static class	AbstractSearchPageController.ShowMode

Nested classes/interfaces inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

AbstractController.HttpNotFoundException

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_PAGE_LIMIT

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

CMS_PAGE_MODEL, CMS_PAGE_TITLE, PAGE_ROOT, REDIRECT_TO_LOGIN_FOR_CHECKOUT, REDIRECT_TO_MULTISTEP_CHECKOUT, REGISTRATION_CONSENT_ID, UTF_8

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

FORWARD_PREFIX, REDIRECT_PREFIX, ROOT

Constructor Summary

Constructors

Constructor	Description
AbstractSearchPageController()

Method Summary

Modifier and Type	Method	Description
protected java.lang.Boolean	calculateShowAll(SearchPageData<?> searchPageData, AbstractSearchPageController.ShowMode showMode)
protected java.lang.Boolean	calculateShowPaged(SearchPageData<?> searchPageData, AbstractSearchPageController.ShowMode showMode)
protected java.util.Map<java.lang.String,FacetData<SearchStateData>>	convertBreadcrumbsToFacets(java.util.List<BreadcrumbData<SearchStateData>> breadcrumbs)
protected PaginationData	createEmptyPagination()
protected PageableData	createPageableData(int pageNumber, int pageSize, java.lang.String sortCode, AbstractSearchPageController.ShowMode showMode)
protected ProductSearchPageData<SearchStateData,ProductData>	encodeSearchPageData(ProductSearchPageData<SearchStateData,ProductData> searchPageData)
protected boolean	existsFacetValueWithName(java.util.List<FacetValueData<SearchStateData>> values, java.lang.String name)
protected int	getMaxSearchPageSize()
protected int	getSearchPageSize()	Get the default search page size.
protected boolean	isShowAllAllowed(SearchPageData<?> searchPageData)	Special case, when total number of results > MAX_PAGE_LIMIT
protected void	populateModel(org.springframework.ui.Model model, SearchPageData<?> searchPageData, AbstractSearchPageController.ShowMode showMode)
protected void	processFacetData(java.util.List<FacetData<SearchStateData>> facets)
protected void	processFacetDatas(java.util.List<FacetValueData<SearchStateData>> facetValueDatas)
protected java.util.List<FacetData<SearchStateData>>	refineFacets(java.util.List<FacetData<SearchStateData>> facets, java.util.Map<java.lang.String,FacetData<SearchStateData>> selectedFacets)

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

addRegistrationConsentDataToModel, checkRequestUrl, createMetaElement, decodeWithScheme, getBaseSiteService, getCheckoutRedirectUrl, getCmsPageService, getCmsPreviewService, getCmsSiteService, getConfigurationService, getConsentFacade, getContentPageForLabelOrId, getCurrencies, getCurrentCurrency, getCurrentLanguage, getCustomerFacade, getHostConfigService, getI18nService, getLanguages, getMessageSource, getPageTitleResolver, getRequestContextData, getSessionService, getSiteConfigService, getSiteName, getSiteUid, getStoreSessionFacade, getUser, getUserFacade, getViewForPage, getViewForPage, prepareNotFoundPage, setUpMetaData, setUpMetaDataForContentPage, storeCmsPageInModel, storeContentPageTitleInModel, storeContinueUrl, urlEncode

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

addRequestToModel, getBean

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PAGE_LIMIT

public static final int MAX_PAGE_LIMIT

See Also:

Constant Field Values

Constructor Detail

AbstractSearchPageController

public AbstractSearchPageController()

Method Detail

createPageableData

protected PageableData createPageableData(int pageNumber,
                                          int pageSize,
                                          java.lang.String sortCode,
                                          AbstractSearchPageController.ShowMode showMode)

createEmptyPagination

protected PaginationData createEmptyPagination()

isShowAllAllowed

protected boolean isShowAllAllowed(SearchPageData<?> searchPageData)

Special case, when total number of results > MAX_PAGE_LIMIT

populateModel

protected void populateModel(org.springframework.ui.Model model,
                             SearchPageData<?> searchPageData,
                             AbstractSearchPageController.ShowMode showMode)

calculateShowAll

protected java.lang.Boolean calculateShowAll(SearchPageData<?> searchPageData,
                                             AbstractSearchPageController.ShowMode showMode)

calculateShowPaged

protected java.lang.Boolean calculateShowPaged(SearchPageData<?> searchPageData,
                                               AbstractSearchPageController.ShowMode showMode)

convertBreadcrumbsToFacets

protected java.util.Map<java.lang.String,FacetData<SearchStateData>> convertBreadcrumbsToFacets(java.util.List<BreadcrumbData<SearchStateData>> breadcrumbs)

refineFacets

protected java.util.List<FacetData<SearchStateData>> refineFacets(java.util.List<FacetData<SearchStateData>> facets,
                                                                  java.util.Map<java.lang.String,FacetData<SearchStateData>> selectedFacets)

existsFacetValueWithName

protected boolean existsFacetValueWithName(java.util.List<FacetValueData<SearchStateData>> values,
                                           java.lang.String name)

getSearchPageSize

protected int getSearchPageSize()

Get the default search page size.

Returns:

the number of results per page, 0 (zero) indicated 'default' size should be used

getMaxSearchPageSize

protected int getMaxSearchPageSize()

encodeSearchPageData

protected ProductSearchPageData<SearchStateData,ProductData> encodeSearchPageData(ProductSearchPageData<SearchStateData,ProductData> searchPageData)

processFacetData

protected void processFacetData(java.util.List<FacetData<SearchStateData>> facets)
                         throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

processFacetDatas

protected void processFacetDatas(java.util.List<FacetValueData<SearchStateData>> facetValueDatas)
                          throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException