com.hybris.instore.widgets.solrsearch

Class SolrSearchController

java.lang.Object

DefaultWidgetController

com.hybris.instore.common.impersonation.AbstractImpersonationController

com.hybris.instore.widgets.solrsearch.SolrSearchController

public class SolrSearchController
extends AbstractImpersonationController

Controller for SolrSearch Widget, which is responsible for all search actions performed in the IN-STORE application:

• category search
• free text search
• facet search

It uses ProductSearchFacade for issuing solr search queries. It extends from AbstractImpersonationController, so all communication with the facade is done within a widget impersonation context.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MODEL_CATEGORYID
protected static String	MODEL_CURRENTFACETS
static String	MODEL_SORT_OPTION
protected static String	MODEL_TEXTSEARCH
static ProductSearchPageData<SearchStateData,ProductData>	NULL_SEARCH_PAGE_DATA
static String	SOCKET_IN_CATEGORYHIERARCHYDATA
static String	SOCKET_IN_REFINEMENTS
static String	SOCKET_IN_RESET
static String	SOCKET_IN_SEARCHQUERY
static String	SOCKET_IN_SMALLSEARCHRESULT
static String	SOCKET_IN_SORTOPTION
static String	SOCKET_OUT_PRODUCTSEARCHPAGE
static String	SOCKET_OUT_SEARCHRESULT
static String	SOCKET_OUT_SMALLSEARCHRESULT
static String	SOCKET_OUT_SORTOPTIONS

Constructor Summary

Constructors

Constructor and Description
SolrSearchController()

Method Summary

Modifier and Type	Method and Description
void	applySearchResult(ProductSearchPageData<SearchStateData,ProductData> searchPageData) Handles the ProductSearchPageData input.
protected ProductSearchPageData	doSearchWithPageSize(String text, String categoryID, List<FacetData<SearchStateData>> refinements, String sort) Performs the actual search for the given text search query, category, search refinements.
protected SearchStateResolver<SearchStateData>	getSolrSearchQueryFacade()
void	refineSearch(List<FacetData<SearchStateData>> refinements) Reads the incoming search refinements FacetData and sends the corresponding search result to the output socket.
void	reset(Pageable<ProductData> pageableProducts) Resets the search state with the given pageable porducts.
void	searchInCategory(CategoryHierarchyData categoryHierarchyData) Socket handler for CategoryHierarchyData input.
void	searchProducts(String query) Socket handler for text search input.
void	setProductSearchFacade(ProductSearchFacade productSearchFacade) Setter for spring injection of ProductSearchFacade.
void	setSolrSearchQueryFacade(SearchStateResolver<SearchStateData> solrSearchQueryFacade)
void	sortProductResult(String sortoption) Reads the sort option String and applies to the current search result.

Methods inherited from class com.hybris.instore.common.impersonation.AbstractImpersonationController

createImpersonationContext, executeInContext, getCatalogVersionService, getContextCatalogVersions, getContextCurrency, getContextLanguage, getImpersonationService, getInStoreService, getSearchRestrictionService, getSessionService, getUserService, setCatalogVersionService, setImpersonationService, setInStoreService, setSearchRestrictionService, setSessionService, setUserService

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_IN_SEARCHQUERY

public static final String SOCKET_IN_SEARCHQUERY

See Also:

Constant Field Values

SOCKET_IN_CATEGORYHIERARCHYDATA

public static final String SOCKET_IN_CATEGORYHIERARCHYDATA

See Also:

Constant Field Values

SOCKET_IN_REFINEMENTS

public static final String SOCKET_IN_REFINEMENTS

See Also:

Constant Field Values

SOCKET_IN_SORTOPTION

public static final String SOCKET_IN_SORTOPTION

See Also:

Constant Field Values

SOCKET_IN_SMALLSEARCHRESULT

public static final String SOCKET_IN_SMALLSEARCHRESULT

See Also:

Constant Field Values

SOCKET_IN_RESET

public static final String SOCKET_IN_RESET

See Also:

Constant Field Values

SOCKET_OUT_SORTOPTIONS

public static final String SOCKET_OUT_SORTOPTIONS

See Also:

Constant Field Values

SOCKET_OUT_PRODUCTSEARCHPAGE

public static final String SOCKET_OUT_PRODUCTSEARCHPAGE

See Also:

Constant Field Values

SOCKET_OUT_SEARCHRESULT

public static final String SOCKET_OUT_SEARCHRESULT

See Also:

Constant Field Values

SOCKET_OUT_SMALLSEARCHRESULT

public static final String SOCKET_OUT_SMALLSEARCHRESULT

See Also:

Constant Field Values

MODEL_SORT_OPTION

public static final String MODEL_SORT_OPTION

See Also:

Constant Field Values

MODEL_TEXTSEARCH

protected static final String MODEL_TEXTSEARCH

See Also:

Constant Field Values

MODEL_CATEGORYID

protected static final String MODEL_CATEGORYID

See Also:

Constant Field Values

MODEL_CURRENTFACETS

protected static final String MODEL_CURRENTFACETS

See Also:

Constant Field Values

NULL_SEARCH_PAGE_DATA

public static final ProductSearchPageData<SearchStateData,ProductData> NULL_SEARCH_PAGE_DATA

Constructor Detail

SolrSearchController

public SolrSearchController()

Method Detail

searchProducts

public void searchProducts(String query)

Socket handler for text search input. Performs ProductSearchFacade#textSearch(SearchStateData, PageableData) in impersonation context.

Parameters:

query -

searchInCategory

public void searchInCategory(CategoryHierarchyData categoryHierarchyData)

Socket handler for CategoryHierarchyData input. Performs ProductSearchFacade#categorySearch(String, SearchStateData, PageableData) in impersonation context.

Parameters:

categoryHierarchyData -

reset

public void reset(Pageable<ProductData> pageableProducts)

Resets the search state with the given pageable porducts. The widget will reset sort options, available facets and the search result according to the given pageable object. Send null value, if the search result should be empty.

Parameters:

pageableProducts - - products to reset search result with. If null - search will be empty

applySearchResult

public void applySearchResult(ProductSearchPageData<SearchStateData,ProductData> searchPageData)

Handles the ProductSearchPageData input. The search was already performed, so it only distributes the search result and sort options.

Parameters:

searchPageData -

sortProductResult

public void sortProductResult(String sortoption)

Reads the sort option String and applies to the current search result.

Parameters:

sortoption -

refineSearch

public void refineSearch(List<FacetData<SearchStateData>> refinements)

Reads the incoming search refinements FacetData and sends the corresponding search result to the output socket.

Parameters:

refinements -

doSearchWithPageSize

protected ProductSearchPageData doSearchWithPageSize(String text,
                                                     String categoryID,
                                                     List<FacetData<SearchStateData>> refinements,
                                                     String sort)

Performs the actual search for the given text search query, category, search refinements. The method respects the sort provided and the configured page size (widget setting - pageSize).

Parameters:

text -

categoryID -

refinements -

sort -

Returns:

ProductSearchPageData - search result

getSolrSearchQueryFacade

protected SearchStateResolver<SearchStateData> getSolrSearchQueryFacade()

Returns:

the solrSearchQueryFacade

setSolrSearchQueryFacade

public void setSolrSearchQueryFacade(SearchStateResolver<SearchStateData> solrSearchQueryFacade)

Parameters:

solrSearchQueryFacade - the solrSearchQueryFacade to set

setProductSearchFacade

public void setProductSearchFacade(ProductSearchFacade productSearchFacade)

Setter for spring injection of ProductSearchFacade.

Parameters:

productSearchFacade -