de.hybris.platform.lucenesearch.hmc

Class SearchResultChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.lucenesearch.hmc.SearchResultChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public class SearchResultChip
extends AbstractChip

Displays the result of a lucenesearch, using a SearchResultListChip, and the search parameters that lead to this result.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
SearchResultChip(DisplayState displayState, AbstractLuceneSearchChip parent, LuceneIndex index, String searchPattern, List searchGroups)

Method Summary

Modifier and Type	Method and Description
void	addFacetProvider(FacetProvider provider) Adds a facet provider to the chip.
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
void	dispose() called when its display state is unbound from its http session.
Facet	gatherSubValues(Facet.FacetValue value) Gathers the sub values for given facet value.
String	getEncodedFacetedSearchPattern()
String	getFacetedSearchPattern() Gets the search pattern extended by the queries of all used facets.
String	getFailureMessage() Gets the reason for failing of search or null if no error has occurred.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
List<SearchResultNavigationChip>	getNavigationChips() Gets the list of all navigation chips.
List<SearchResultListChip>	getResultListChips() Gets the list of all result chips.
Language	getSearchLanguage() Gets the language used for search
String	getSearchPattern() Gets the search pattern without maybe used facets.
protected void	init() Initializes the chip.
protected boolean	isInitialized() Checks whether the chip is already initialized (this chip uses lazy initialization).
void	processEvents(Map events) Handles all incoming requests for this chip.
void	update(SearchResultNavigationChip chip, boolean updateNavigation) Updates the search results by using the selected facet values of all navigations.

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultChip

public SearchResultChip(DisplayState displayState,
                        AbstractLuceneSearchChip parent,
                        LuceneIndex index,
                        String searchPattern,
                        List searchGroups)

Method Detail

addFacetProvider

public void addFacetProvider(FacetProvider provider)

Adds a facet provider to the chip. Can only be called for initialization. For each provider a navigation chip will be managed.

Parameters:

provider - provider of a facet

init

protected void init()

Initializes the chip. Creates the navigations with corresponding facets and calls a first update at the first navigation.

gatherSubValues

public Facet gatherSubValues(Facet.FacetValue value)

Gathers the sub values for given facet value. Can only be called once for a facet value.

Parameters:

value - facet value for which the sub values will be gathered and set

update

public void update(SearchResultNavigationChip chip,
                   boolean updateNavigation)

Updates the search results by using the selected facet values of all navigations. The search result list will be constructed from scratch using the selected facet values as filter. A search result is constructed for each sub value of the selected facet value of the given navigation. Optional, the facet values of the navigations will be updated too.

Parameters:

chip - for each sub value of selected facet value of this navigation chip a search result is constructed

updateNavigation - true for updating the facet values of each navigation too (a second search is needed)

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

getResultListChips

public List<SearchResultListChip> getResultListChips()

Gets the list of all result chips.

Returns:

list of all result chips

isInitialized

protected boolean isInitialized()

Checks whether the chip is already initialized (this chip uses lazy initialization).

Returns:

true if the chip is already initialized, false otherwise

getNavigationChips

public List<SearchResultNavigationChip> getNavigationChips()

Gets the list of all navigation chips.

Returns:

list of navigation chips

getSearchLanguage

public Language getSearchLanguage()

Gets the language used for search

Returns:

search language

getSearchPattern

public String getSearchPattern()

Gets the search pattern without maybe used facets.

Returns:

search pattern

getFacetedSearchPattern

public String getFacetedSearchPattern()

Gets the search pattern extended by the queries of all used facets.

Returns:

search pattern concatenated with facet queries

getEncodedFacetedSearchPattern

public String getEncodedFacetedSearchPattern()

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

getFailureMessage

public String getFailureMessage()

Gets the reason for failing of search or null if no error has occurred.

Returns:

failure message or null

dispose

public void dispose()

Description copied from interface: Chip

called when its display state is unbound from its http session. this means it is no longer used.

Specified by:

dispose in interface Chip

Overrides:

dispose in class AbstractChip