Package com.hybris.backoffice.widgets.fulltextsearch

Class FullTextSearchController

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.ViewAnnotationAwareComposer

com.hybris.cockpitng.util.DefaultWidgetController

com.hybris.backoffice.widgets.advancedsearch.AbstractSearchController

com.hybris.backoffice.widgets.fulltextsearch.FullTextSearchController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, java.io.Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class FullTextSearchController
extends AbstractSearchController

Widget controller of the full text search widget.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIG_CONTEXT_STRATEGY
protected static java.lang.Boolean	DEFAULT_VALUE_FIELD_QUERY_ENABLED
protected static java.lang.String	DEFAULT_VALUE_FULLTEXT_SEARCH_CONFIG_CTX_CODE
static java.lang.String	EVENT_ON_APPLY_FILTERS
protected static java.lang.String	FIELD_QUERY_POPUP
protected static java.lang.String	MODEL_DATA_TYPE
protected static java.lang.String	MODEL_FIELD_QUERIES
static java.lang.String	MODEL_FIELD_QUERY_POPUP_FILTERS
protected static java.lang.String	MODEL_FILTERS_COUNTER
protected static java.lang.String	MODEL_KEY_FULLTEXTSEARCH_IS_EXPANDED
protected static java.lang.String	MODEL_KEY_MOUSE_OVER_SEARCH_BUTTON
protected static java.lang.String	MODEL_KEY_SELECTED_FACETS
protected static java.lang.String	MODEL_KEY_SELECTED_TYPE
static java.lang.String	MODEL_PREFERRED_STRATEGY
static java.lang.String	NOTIFICATION_EVENT_TYPE_FILTER_INVALID
protected static java.lang.String	SELECTED_FACETS	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - not used anymore
protected static java.lang.String	SETTING_FIELD_QUERY_ENABLED
protected static java.lang.String	SETTING_FULLTEXT_SEARCH_CONFIG_CTX_CODE
protected static java.lang.String	SETTING_PREFERRED_SEARCH_STRATEGY
static java.lang.String	SOCKET_IN_AUTO_SUGGESTIONS
static java.lang.String	SOCKET_IN_CLEAR
static java.lang.String	SOCKET_IN_FULL_TEXT_SEARCH_DATA
static java.lang.String	SOCKET_IN_INIT_CONTEXT
static java.lang.String	SOCKET_IN_RESET
static java.lang.String	SOCKET_IN_TYPE
static java.lang.String	SOCKET_OUT_SEARCH_CONTEXT_CHANGED

Fields inherited from class com.hybris.backoffice.widgets.advancedsearch.AbstractSearchController

MODEL_INIT_CONTEXT, MODEL_INITIALIZED_FROM_INIT_CTX, permissionFacade, SEARCH_MODEL, searchBox, SETTING_ACTION_SLOT_COMPONENT_CTX, SETTING_ADVANCED_SEARCH_CONFIG_CTX_CODE, SETTING_DISABLE_AUTO_SEARCH, SETTING_MIN_AUTO_SUGGESTIONS_QUERY_LENGTH, SETTING_SIMPLE_SEARCH_CONFIG_CTX_CODE, SIMPLE_SEARCH_MODE_ACTIVE, SIMPLE_SEARCH_TEXT_QUERY, SOCKET_OUT_AUTO_SUGGESTION_DATA, SOCKET_OUT_SEARCH_DATA, typeFacade

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor	Description
FullTextSearchController()

Method Summary

Modifier and Type	Method	Description
protected void	adjustFieldQuery()
protected void	adjustWidgetModel(AdvancedSearch advancedSearch, AdvancedSearchData searchData, boolean rootTypeChanged, DataType dataType)
protected void	applyFilters(AdvancedSearchData queryData)
protected java.util.List<SearchConditionData>	buildSearchConditionData(java.util.Map<java.lang.String,FullTextSearchFilter> filters)
protected boolean	canProcessFilterChangeEvent(org.zkoss.zk.ui.event.Event event)
void	changeSearchContext(java.lang.String strategy)
void	changeType(java.lang.String typeCode)
void	clear()
protected void	clearAppliedFilters()
protected void	clearLocalizedValues(java.lang.Object value, java.util.Locale locale)
protected AdvancedSearchData	createAdvancedSearchDataWithInitContext()	Creates a new instance of AdvancedSearchData.
protected boolean	doSearch()
protected boolean	doSimpleSearch()
protected void	extractAndRememberSelectedFacets(java.util.Collection<FacetData> allFacets)
org.zkoss.zul.Button	getClearButton()
protected DataType	getCurrentDataType()
protected org.zkoss.zul.Button	getFieldQueryButton()
protected org.zkoss.zul.Label	getFieldQueryFiltersCounterLabel()
protected org.zkoss.zul.Popup	getFieldQueryPopup()
protected WidgetComponentRenderer<org.zkoss.zul.Popup,FulltextSearch,AdvancedSearchData>	getFieldQueryPopupRenderer()
protected org.zkoss.zul.Div	getFullTextSearchBox()
protected org.zkoss.zul.Div	getFullTextSearchContainer()
protected java.util.Set<FullTextSearchFilter>	getInvalidFilters(java.lang.String typeCode)
protected NotificationService	getNotificationService()
protected java.lang.String	getPreferredSearchStrategy()
protected org.zkoss.zul.Button	getSearchButton()
protected SearchFilterValidationStrategy	getSearchFilterValidationStrategy(java.lang.String typeCode)
protected SearchFilterValidationStrategyRegistry	getSearchFilterValidationStrategyRegistry()
protected void	handleInvalidFilters(java.util.Collection<FullTextSearchFilter> invalidFilters)
protected ValueComparisonOperator	handlePreferredGlobalOperator(AdvancedSearchData searchData)
protected void	handlePreferredSearchStrategy(AdvancedSearchData searchData)
void	initialize(org.zkoss.zk.ui.Component comp)	Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
protected void	initializeFieldQueryComponents()
protected void	initializeFieldQueryFiltersCounterLabel()
void	initializeWithContext(AdvancedSearchInitContext initContext)
protected boolean	isFieldQueryEnabled()
protected FulltextSearch	loadFullTextConfiguration(java.lang.String type)
void	onApplyFilters(org.zkoss.zk.ui.event.Event event)
void	onAutoSuggestions(java.util.Map<java.lang.String,java.util.Collection> autoSuggestions)
protected void	onClearButtonClick(org.zkoss.zk.ui.event.Event event)
void	onFullTextSearchData(FullTextSearchData fullTextSearchData)
protected void	onSearchBoxBlur(org.zkoss.zk.ui.event.Event event)
protected boolean	onSearchBoxOk(org.zkoss.zk.ui.event.Event event)
protected void	onSearchBoxValueChange(org.zkoss.zk.ui.event.Event event)
protected void	onSearchButtonClick(org.zkoss.zk.ui.event.Event event)
protected void	onSearchButtonMouseOut(org.zkoss.zk.ui.event.Event event)
protected void	onSearchButtonMouseOver(org.zkoss.zk.ui.event.Event event)
void	reset()
protected void	saveFiltersCounterInModel(org.zkoss.zk.ui.event.Event event)
protected void	saveFiltersCounterModelValue(int numberOfFilters)
void	setClearButton(org.zkoss.zul.Button clearButton)
void	setFieldQueryButton(org.zkoss.zul.Button fieldQueryButton)
void	setFieldQueryFiltersCounterLabel(org.zkoss.zul.Label fieldQueryFiltersCounterLabel)
void	setFieldQueryPopup(org.zkoss.zul.Popup fieldQueryPopup)
void	setFieldQueryPopupRenderer(WidgetComponentRenderer<org.zkoss.zul.Popup,FulltextSearch,AdvancedSearchData> fieldQueryPopupRenderer)
protected void	setFiltersCounterLabelValue(int numberOfFilters)
void	setFullTextSearchBox(org.zkoss.zul.Div fullTextSearchBox)
void	setFullTextSearchContainer(org.zkoss.zul.Div fullTextSearchContainer)
void	setNotificationService(NotificationService notificationService)
protected void	setPreferredSearchStrategy(java.lang.String strategy)
void	setSearchButton(org.zkoss.zul.Button searchButton)
void	setSearchFilterValidationStrategyRegistry(SearchFilterValidationStrategyRegistry searchFilterValidationStrategyRegistry)
protected void	updateFilterCounter(java.util.Map<java.lang.String,FullTextSearchFilter> filters)
protected void	updateFiltersCounterLabel(org.zkoss.zk.ui.event.Event event)

Methods inherited from class com.hybris.backoffice.widgets.advancedsearch.AbstractSearchController

applySimpleSearchConfiguration, buildQueryData, canReadType, clearSearchBoxAndRelatedViews, createListenerForBandPopup, getActionSlot, getAutosuggestionBandpopup, getAutosuggestionListbox, getCompleteSuggestion, getPermissionFacade, getSearchText, getTypeFacade, initAutoSuggestionAndAutoCorrectionComponents, isApplicableForSimpleSearch, isSearchBoxOrRelatedViewsNull, isSimpleSearchActive, loadConfiguration, loadConfiguration, loadDataTypeForCode, loadSimpleConfiguration, openSearchBoxWithBandPopup, populateAutoSuggestions, processAutoSuggestions, processFullTextSearchData, requestAutoSuggestions, setActionSlot, setActionSlotTypeCode, setAutosuggestionBandpopup, setAutosuggestionListbox, setPermissionFacade, setTypeFacade, shouldPopulateAutoSuggestions

Methods inherited from class com.hybris.cockpitng.util.DefaultWidgetController

doAfterCompose, doBeforeCompose, doBeforeComposeChildren, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, getValue, getWidgetDragAndDropStrategyRepository, getWidgetInstanceManager, getWidgetRoot, getWidgetSettings, getWidgetslot, getWidgetTitle, getWidgetUtils, initDragAndDropAwareness, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, invokeListenerMethod, onSocketInput, preInitialize, sendOutput, sendOutputAfterOperation, sendOutputAfterOperation, sendOutputAfterOperation, setValue, setWidgetInstanceManager, setWidgetTitle

Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer

scanEventListeners

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_IN_INIT_CONTEXT

public static final java.lang.String SOCKET_IN_INIT_CONTEXT

See Also:

Constant Field Values

SOCKET_IN_FULL_TEXT_SEARCH_DATA

public static final java.lang.String SOCKET_IN_FULL_TEXT_SEARCH_DATA

See Also:

Constant Field Values

SOCKET_IN_TYPE

public static final java.lang.String SOCKET_IN_TYPE

See Also:

Constant Field Values

SOCKET_IN_AUTO_SUGGESTIONS

public static final java.lang.String SOCKET_IN_AUTO_SUGGESTIONS

See Also:

Constant Field Values

SOCKET_IN_RESET

public static final java.lang.String SOCKET_IN_RESET

See Also:

Constant Field Values

SOCKET_IN_CLEAR

public static final java.lang.String SOCKET_IN_CLEAR

See Also:

Constant Field Values

SOCKET_OUT_SEARCH_CONTEXT_CHANGED

public static final java.lang.String SOCKET_OUT_SEARCH_CONTEXT_CHANGED

See Also:

Constant Field Values

MODEL_PREFERRED_STRATEGY

public static final java.lang.String MODEL_PREFERRED_STRATEGY

See Also:

Constant Field Values

CONFIG_CONTEXT_STRATEGY

public static final java.lang.String CONFIG_CONTEXT_STRATEGY

See Also:

Constant Field Values

MODEL_FIELD_QUERY_POPUP_FILTERS

public static final java.lang.String MODEL_FIELD_QUERY_POPUP_FILTERS

See Also:

Constant Field Values

EVENT_ON_APPLY_FILTERS

public static final java.lang.String EVENT_ON_APPLY_FILTERS

See Also:

Constant Field Values

NOTIFICATION_EVENT_TYPE_FILTER_INVALID

public static final java.lang.String NOTIFICATION_EVENT_TYPE_FILTER_INVALID

See Also:

Constant Field Values

MODEL_KEY_FULLTEXTSEARCH_IS_EXPANDED

protected static final java.lang.String MODEL_KEY_FULLTEXTSEARCH_IS_EXPANDED

See Also:

Constant Field Values

MODEL_KEY_MOUSE_OVER_SEARCH_BUTTON

protected static final java.lang.String MODEL_KEY_MOUSE_OVER_SEARCH_BUTTON

See Also:

Constant Field Values

MODEL_DATA_TYPE

protected static final java.lang.String MODEL_DATA_TYPE

See Also:

Constant Field Values

MODEL_KEY_SELECTED_TYPE

protected static final java.lang.String MODEL_KEY_SELECTED_TYPE

See Also:

Constant Field Values

MODEL_FILTERS_COUNTER

protected static final java.lang.String MODEL_FILTERS_COUNTER

See Also:

Constant Field Values

FIELD_QUERY_POPUP

protected static final java.lang.String FIELD_QUERY_POPUP

See Also:

Constant Field Values

MODEL_FIELD_QUERIES

protected static final java.lang.String MODEL_FIELD_QUERIES

See Also:

Constant Field Values

SETTING_FULLTEXT_SEARCH_CONFIG_CTX_CODE

protected static final java.lang.String SETTING_FULLTEXT_SEARCH_CONFIG_CTX_CODE

See Also:

Constant Field Values

DEFAULT_VALUE_FULLTEXT_SEARCH_CONFIG_CTX_CODE

protected static final java.lang.String DEFAULT_VALUE_FULLTEXT_SEARCH_CONFIG_CTX_CODE

See Also:

Constant Field Values

SETTING_FIELD_QUERY_ENABLED

protected static final java.lang.String SETTING_FIELD_QUERY_ENABLED

See Also:

Constant Field Values

SETTING_PREFERRED_SEARCH_STRATEGY

protected static final java.lang.String SETTING_PREFERRED_SEARCH_STRATEGY

See Also:

Constant Field Values

DEFAULT_VALUE_FIELD_QUERY_ENABLED

protected static final java.lang.Boolean DEFAULT_VALUE_FIELD_QUERY_ENABLED

SELECTED_FACETS

@Deprecated(since="6.7",
            forRemoval=true)
protected static final java.lang.String SELECTED_FACETS

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - not used anymore

See Also:

Constant Field Values

MODEL_KEY_SELECTED_FACETS

protected static final java.lang.String MODEL_KEY_SELECTED_FACETS

See Also:

Constant Field Values

Constructor Detail

FullTextSearchController

public FullTextSearchController()

Method Detail

initialize

public void initialize(org.zkoss.zk.ui.Component comp)

Description copied from class: DefaultWidgetController

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by DefaultWidgetController.doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

Overrides:

initialize in class DefaultWidgetController

onApplyFilters

public void onApplyFilters(org.zkoss.zk.ui.event.Event event)

clearAppliedFilters

protected void clearAppliedFilters()

updateFilterCounter

protected void updateFilterCounter(java.util.Map<java.lang.String,FullTextSearchFilter> filters)

setFiltersCounterLabelValue

protected void setFiltersCounterLabelValue(int numberOfFilters)

saveFiltersCounterModelValue

protected void saveFiltersCounterModelValue(int numberOfFilters)

buildSearchConditionData

protected java.util.List<SearchConditionData> buildSearchConditionData(java.util.Map<java.lang.String,FullTextSearchFilter> filters)

clearLocalizedValues

protected void clearLocalizedValues(java.lang.Object value,
                                    java.util.Locale locale)

isFieldQueryEnabled

protected boolean isFieldQueryEnabled()

initializeFieldQueryComponents

protected void initializeFieldQueryComponents()

changeSearchContext

public void changeSearchContext(java.lang.String strategy)

getPreferredSearchStrategy

protected java.lang.String getPreferredSearchStrategy()

setPreferredSearchStrategy

protected void setPreferredSearchStrategy(java.lang.String strategy)

initializeWithContext

public void initializeWithContext(AdvancedSearchInitContext initContext)

handlePreferredSearchStrategy

protected void handlePreferredSearchStrategy(AdvancedSearchData searchData)

initializeFieldQueryFiltersCounterLabel

protected void initializeFieldQueryFiltersCounterLabel()

adjustFieldQuery

protected void adjustFieldQuery()

loadFullTextConfiguration

protected FulltextSearch loadFullTextConfiguration(java.lang.String type)

onFullTextSearchData

public void onFullTextSearchData(FullTextSearchData fullTextSearchData)

changeType

public void changeType(java.lang.String typeCode)

onAutoSuggestions

public void onAutoSuggestions(java.util.Map<java.lang.String,java.util.Collection> autoSuggestions)

reset

public void reset()

clear

public void clear()

updateFiltersCounterLabel

protected void updateFiltersCounterLabel(org.zkoss.zk.ui.event.Event event)

saveFiltersCounterInModel

protected void saveFiltersCounterInModel(org.zkoss.zk.ui.event.Event event)

canProcessFilterChangeEvent

protected boolean canProcessFilterChangeEvent(org.zkoss.zk.ui.event.Event event)

onSearchButtonMouseOut

protected void onSearchButtonMouseOut(org.zkoss.zk.ui.event.Event event)

onSearchButtonMouseOver

protected void onSearchButtonMouseOver(org.zkoss.zk.ui.event.Event event)

onClearButtonClick

protected void onClearButtonClick(org.zkoss.zk.ui.event.Event event)

onSearchBoxValueChange

protected void onSearchBoxValueChange(org.zkoss.zk.ui.event.Event event)

onSearchBoxOk

protected boolean onSearchBoxOk(org.zkoss.zk.ui.event.Event event)

onSearchBoxBlur

protected void onSearchBoxBlur(org.zkoss.zk.ui.event.Event event)

onSearchButtonClick

protected void onSearchButtonClick(org.zkoss.zk.ui.event.Event event)

doSearch

protected boolean doSearch()

adjustWidgetModel

protected void adjustWidgetModel(AdvancedSearch advancedSearch,
                                 AdvancedSearchData searchData,
                                 boolean rootTypeChanged,
                                 DataType dataType)

Specified by:

adjustWidgetModel in class AbstractSearchController

createAdvancedSearchDataWithInitContext

protected AdvancedSearchData createAdvancedSearchDataWithInitContext()

Description copied from class: AbstractSearchController

Creates a new instance of AdvancedSearchData. If AbstractSearchController.MODEL_INIT_CONTEXT in widgetModel is not null then a copy of its AdvancedSearchInitContext.getAdvancedSearchData() is returned

Overrides:

createAdvancedSearchDataWithInitContext in class AbstractSearchController

Returns:

the new instance of AdvancedSearchData.

handlePreferredGlobalOperator

protected ValueComparisonOperator handlePreferredGlobalOperator(AdvancedSearchData searchData)

doSimpleSearch

protected boolean doSimpleSearch()

Specified by:

doSimpleSearch in class AbstractSearchController

applyFilters

protected void applyFilters(AdvancedSearchData queryData)

getInvalidFilters

protected java.util.Set<FullTextSearchFilter> getInvalidFilters(java.lang.String typeCode)

getSearchFilterValidationStrategy

protected SearchFilterValidationStrategy getSearchFilterValidationStrategy(java.lang.String typeCode)

handleInvalidFilters

protected void handleInvalidFilters(java.util.Collection<FullTextSearchFilter> invalidFilters)

getCurrentDataType

protected DataType getCurrentDataType()

getFieldQueryPopupRenderer

protected WidgetComponentRenderer<org.zkoss.zul.Popup,FulltextSearch,AdvancedSearchData> getFieldQueryPopupRenderer()

setFieldQueryPopupRenderer

public void setFieldQueryPopupRenderer(WidgetComponentRenderer<org.zkoss.zul.Popup,FulltextSearch,AdvancedSearchData> fieldQueryPopupRenderer)

getSearchButton

protected org.zkoss.zul.Button getSearchButton()

setSearchButton

public void setSearchButton(org.zkoss.zul.Button searchButton)

getFieldQueryButton

protected org.zkoss.zul.Button getFieldQueryButton()

setFieldQueryButton

public void setFieldQueryButton(org.zkoss.zul.Button fieldQueryButton)

getFullTextSearchContainer

protected org.zkoss.zul.Div getFullTextSearchContainer()

setFullTextSearchContainer

public void setFullTextSearchContainer(org.zkoss.zul.Div fullTextSearchContainer)

getFullTextSearchBox

protected org.zkoss.zul.Div getFullTextSearchBox()

setFullTextSearchBox

public void setFullTextSearchBox(org.zkoss.zul.Div fullTextSearchBox)

getFieldQueryFiltersCounterLabel

protected org.zkoss.zul.Label getFieldQueryFiltersCounterLabel()

setFieldQueryFiltersCounterLabel

public void setFieldQueryFiltersCounterLabel(org.zkoss.zul.Label fieldQueryFiltersCounterLabel)

getFieldQueryPopup

protected org.zkoss.zul.Popup getFieldQueryPopup()

setFieldQueryPopup

public void setFieldQueryPopup(org.zkoss.zul.Popup fieldQueryPopup)

getClearButton

public org.zkoss.zul.Button getClearButton()

setClearButton

public void setClearButton(org.zkoss.zul.Button clearButton)

getNotificationService

protected NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)

getSearchFilterValidationStrategyRegistry

protected SearchFilterValidationStrategyRegistry getSearchFilterValidationStrategyRegistry()

setSearchFilterValidationStrategyRegistry

public void setSearchFilterValidationStrategyRegistry(SearchFilterValidationStrategyRegistry searchFilterValidationStrategyRegistry)

extractAndRememberSelectedFacets

protected void extractAndRememberSelectedFacets(java.util.Collection<FacetData> allFacets)