de.hybris.commercesearchbackoffice.widgets.solrsearch

Class SolrSearchController

java.lang.Object

DefaultWidgetController

de.hybris.commercesearchbackoffice.widgets.common.impersonation.AbstractImpersonationController

de.hybris.commercesearchbackoffice.widgets.solrsearch.SolrSearchController

public class SolrSearchController
extends AbstractImpersonationController

Controller for SolrSearch Widget, which is responsible for all search actions performed in the commercesearchbackoffice 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 java.lang.String	FAILED_SEARCH
protected static java.lang.String	MODEL_CATEGORYDATA
protected static java.lang.String	MODEL_CATEGORYID
protected static java.lang.String	MODEL_CURRENTFACETS
protected static java.lang.String	MODEL_CURRENTPAGESIZE
protected static java.lang.String	MODEL_TEXTSEARCH
static ProductSearchPageData<SearchStateData,ProductData>	NULL_SEARCH_PAGE_DATA
static java.lang.String	SOCKET_IN_AFTER_REMOVAL
static java.lang.String	SOCKET_IN_CATEGORYDATA
static java.lang.String	SOCKET_IN_REFINEMENTS
static java.lang.String	SOCKET_IN_SEARCHQUERY
static java.lang.String	SOCKET_OUT_NEW_REFINEMENTS
static java.lang.String	SOCKET_OUT_RESET_REFINEMENTS
static java.lang.String	SOCKET_OUT_SEARCH_RESULT_PAGE
static java.lang.String	SOCKET_OUT_SEARCHRESULT
static java.lang.String	SOCKET_OUT_SOLR_ERROR
protected static java.lang.String	SOLR_ERROR

Constructor Summary

Constructors

Constructor and Description
SolrSearchController()

Method Summary

Modifier and Type	Method and Description
protected void	doSearchInCategory(CategoryData categoryData)
protected ProductSearchPageData	doSearchWithPageSize(java.lang.String text, java.lang.String categoryId, java.util.List<FacetData<SearchStateData>> refinements, java.lang.String sort) Performs the actual search for the given text search query, category, search refinements.
protected SearchStateResolver<SearchStateData>	getSolrSearchQueryFacade()
void	refineSearch(java.util.List<FacetData<SearchStateData>> refinements) Reads the incoming search refinements FacetData and sends the corresponding search result to the output sockets.
protected void	resetSearchState()
void	searchInCategory(CategoryData categoryData) Socket handler for category search input.
void	searchProducts(java.lang.String query) Socket handler for text search input.
void	setProductSearchFacade(ProductSearchFacade productSearchFacade)
void	setSolrSearchQueryFacade(SearchStateResolver<SearchStateData> solrSearchQueryFacade)

Methods inherited from class de.hybris.commercesearchbackoffice.widgets.common.impersonation.AbstractImpersonationController

createImpersonationContext, executeInContext, getCurrentBaseSite, getCurrentBaseStore, getCurrentCatalogVersion, getCurrentCurrency, getCurrentLanguage

Methods inherited from class java.lang.Object

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

Field Detail

FAILED_SEARCH

protected static final java.lang.String FAILED_SEARCH

See Also:

Constant Field Values

SOLR_ERROR

protected static final java.lang.String SOLR_ERROR

See Also:

Constant Field Values

SOCKET_IN_SEARCHQUERY

public static final java.lang.String SOCKET_IN_SEARCHQUERY

See Also:

Constant Field Values

SOCKET_IN_CATEGORYDATA

public static final java.lang.String SOCKET_IN_CATEGORYDATA

See Also:

Constant Field Values

SOCKET_IN_AFTER_REMOVAL

public static final java.lang.String SOCKET_IN_AFTER_REMOVAL

See Also:

Constant Field Values

SOCKET_IN_REFINEMENTS

public static final java.lang.String SOCKET_IN_REFINEMENTS

See Also:

Constant Field Values

SOCKET_OUT_SEARCHRESULT

public static final java.lang.String SOCKET_OUT_SEARCHRESULT

See Also:

Constant Field Values

SOCKET_OUT_SEARCH_RESULT_PAGE

public static final java.lang.String SOCKET_OUT_SEARCH_RESULT_PAGE

See Also:

Constant Field Values

SOCKET_OUT_NEW_REFINEMENTS

public static final java.lang.String SOCKET_OUT_NEW_REFINEMENTS

See Also:

Constant Field Values

SOCKET_OUT_RESET_REFINEMENTS

public static final java.lang.String SOCKET_OUT_RESET_REFINEMENTS

See Also:

Constant Field Values

SOCKET_OUT_SOLR_ERROR

public static final java.lang.String SOCKET_OUT_SOLR_ERROR

See Also:

Constant Field Values

NULL_SEARCH_PAGE_DATA

public static final ProductSearchPageData<SearchStateData,ProductData> NULL_SEARCH_PAGE_DATA

MODEL_TEXTSEARCH

protected static final java.lang.String MODEL_TEXTSEARCH

See Also:

Constant Field Values

MODEL_CATEGORYID

protected static final java.lang.String MODEL_CATEGORYID

See Also:

Constant Field Values

MODEL_CATEGORYDATA

protected static final java.lang.String MODEL_CATEGORYDATA

See Also:

Constant Field Values

MODEL_CURRENTFACETS

protected static final java.lang.String MODEL_CURRENTFACETS

See Also:

Constant Field Values

MODEL_CURRENTPAGESIZE

protected static final java.lang.String MODEL_CURRENTPAGESIZE

See Also:

Constant Field Values

Constructor Detail

SolrSearchController

public SolrSearchController()

Method Detail

searchProducts

public void searchProducts(java.lang.String query)

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

Parameters:

query - keyword to search

searchInCategory

public void searchInCategory(CategoryData categoryData)

Socket handler for category search input. Performs category search in impersonation context.

Parameters:

categoryData - Category to search

doSearchInCategory

protected void doSearchInCategory(CategoryData categoryData)

resetSearchState

protected void resetSearchState()

refineSearch

public void refineSearch(java.util.List<FacetData<SearchStateData>> refinements)

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

Parameters:

refinements -

doSearchWithPageSize

protected ProductSearchPageData doSearchWithPageSize(java.lang.String text,
                                                     java.lang.String categoryId,
                                                     java.util.List<FacetData<SearchStateData>> refinements,
                                                     java.lang.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()

setSolrSearchQueryFacade

public void setSolrSearchQueryFacade(SearchStateResolver<SearchStateData> solrSearchQueryFacade)

setProductSearchFacade

public void setProductSearchFacade(ProductSearchFacade productSearchFacade)