com.hybris.backoffice.widgets.advancedsearch

Class AbstractSearchController

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.AbstractBackofficeWidgetController

com.hybris.backoffice.widgets.advancedsearch.AbstractSearchController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, 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>

Direct Known Subclasses:

AdvancedSearchController, FullTextSearchController

public abstract class AbstractSearchController
extends AbstractBackofficeWidgetController

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CockpitLocaleService	cockpitLocaleService Deprecated. since 6.7, will be removed in the future.
protected LabelService	labelService Deprecated. since 6.7, will be removed in the future.
static String	MODEL_INIT_CONTEXT
static String	MODEL_INITIALIZED_FROM_INIT_CTX
protected PermissionFacade	permissionFacade Deprecated. since 6.7, will be removed in the future.
static String	SEARCH_MODEL
protected org.zkoss.zul.Bandbox	searchBox
protected static String	SETTING_ACTION_SLOT_COMPONENT_CTX
protected static String	SETTING_ADVANCED_SEARCH_CONFIG_CTX_CODE
protected static String	SETTING_DISABLE_AUTO_SEARCH
protected static String	SETTING_MIN_AUTO_SUGGESTIONS_QUERY_LENGTH
protected static String	SETTING_SIMPLE_SEARCH_CONFIG_CTX_CODE
protected static String	SIMPLE_SEARCH_MODE_ACTIVE
static String	SIMPLE_SEARCH_TEXT_QUERY
static String	SOCKET_OUT_AUTO_SUGGESTION_DATA
static String	SOCKET_OUT_SEARCH_DATA
protected TypeFacade	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 and Description
AbstractSearchController()

Method Summary

Modifier and Type	Method and Description
protected abstract void	adjustWidgetModel(AdvancedSearch advancedSearch, AdvancedSearchData searchData, boolean rootTypeChanged, DataType dataType)
protected void	applySimpleSearchConfiguration(String searchText, String typeCode, AdvancedSearchData queryData)
protected AdvancedSearchData	buildQueryData(String searchText, String typeCode)
protected boolean	canReadType(String typeCode) Deprecated. since 6.7, the method will not be used anymore
protected void	clearSearchBox() Deprecated. since 6.7, the method will not be used anymore
protected void	clearSearchBoxAndRelatedViews()
protected AdvancedSearchData	createAdvancedSearchDataWithInitContext() Creates a new instance of AdvancedSearchData.
protected void	createListenerForBandPopup()
protected abstract boolean	doSimpleSearch()
protected Actions	getActionSlot()
protected org.zkoss.zul.Bandpopup	getAutosuggestionBandpopup()
protected org.zkoss.zul.Listbox	getAutosuggestionListbox()
protected String	getCompleteSuggestion(String searchedPhraseWithoutLastWord, String suggestion)
protected LabelService	getLabelService() Deprecated. since 6.7, will be removed in the future.
protected String	getSearchText()
protected TypeFacade	getTypeFacade()
protected void	initAutoSuggestionAndAutoCorrectionComponents()
protected boolean	isSearchBoxOrRelatedViewsNull()
protected boolean	isSimpleSearchActive()
protected <T> T	loadConfiguration(ConfigContext configurationContext, Class<T> configurationClass)
protected <T> T	loadConfiguration(String type, String configurationContextCode, Class<T> configurationClass)
protected DataType	loadDataTypeForCode(String typeCode)
protected SimpleSearch	loadSimpleConfiguration(String type)
protected void	openSearchBoxWithBandPopup()
protected void	populateAutoSuggestions(String query)
protected void	processAutoSuggestions(Map<String,Collection> autoSuggestions)
protected void	processFullTextSearchData(FullTextSearchData fullTextSearchData)
void	requestAutoSuggestions()
protected void	setActionSlot(Actions actionSlot)
protected void	setActionSlotTypeCode(String typeCode)
protected void	setAutosuggestionBandpopup(org.zkoss.zul.Bandpopup autosuggestionBandpopup)
protected void	setAutosuggestionListbox(org.zkoss.zul.Listbox autosuggestionListbox)
void	setTypeFacade(TypeFacade typeFacade)
protected boolean	shouldPopulateAutoSuggestions(String query)

Methods inherited from class com.hybris.backoffice.widgets.AbstractBackofficeWidgetController

getNotificationSource, handleRuntimeException

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, initialize, 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

SEARCH_MODEL

public static final String SEARCH_MODEL

See Also:

Constant Field Values

MODEL_INIT_CONTEXT

public static final String MODEL_INIT_CONTEXT

See Also:

Constant Field Values

SIMPLE_SEARCH_TEXT_QUERY

public static final String SIMPLE_SEARCH_TEXT_QUERY

See Also:

Constant Field Values

MODEL_INITIALIZED_FROM_INIT_CTX

public static final String MODEL_INITIALIZED_FROM_INIT_CTX

See Also:

Constant Field Values

SOCKET_OUT_AUTO_SUGGESTION_DATA

public static final String SOCKET_OUT_AUTO_SUGGESTION_DATA

See Also:

Constant Field Values

SOCKET_OUT_SEARCH_DATA

public static final String SOCKET_OUT_SEARCH_DATA

See Also:

Constant Field Values

SETTING_DISABLE_AUTO_SEARCH

protected static final String SETTING_DISABLE_AUTO_SEARCH

See Also:

Constant Field Values

SETTING_SIMPLE_SEARCH_CONFIG_CTX_CODE

protected static final String SETTING_SIMPLE_SEARCH_CONFIG_CTX_CODE

See Also:

Constant Field Values

SIMPLE_SEARCH_MODE_ACTIVE

protected static final String SIMPLE_SEARCH_MODE_ACTIVE

See Also:

Constant Field Values

SETTING_ACTION_SLOT_COMPONENT_CTX

protected static final String SETTING_ACTION_SLOT_COMPONENT_CTX

See Also:

Constant Field Values

SETTING_ADVANCED_SEARCH_CONFIG_CTX_CODE

protected static final String SETTING_ADVANCED_SEARCH_CONFIG_CTX_CODE

See Also:

Constant Field Values

SETTING_MIN_AUTO_SUGGESTIONS_QUERY_LENGTH

protected static final String SETTING_MIN_AUTO_SUGGESTIONS_QUERY_LENGTH

See Also:

Constant Field Values

typeFacade

protected transient TypeFacade typeFacade

labelService

@Deprecated
protected transient LabelService labelService

Deprecated. since 6.7, will be removed in the future.

permissionFacade

@Deprecated
protected transient PermissionFacade permissionFacade

Deprecated. since 6.7, will be removed in the future.

cockpitLocaleService

@Deprecated
protected transient CockpitLocaleService cockpitLocaleService

Deprecated. since 6.7, will be removed in the future.

searchBox

protected org.zkoss.zul.Bandbox searchBox

Constructor Detail

AbstractSearchController

public AbstractSearchController()

Method Detail

requestAutoSuggestions

public void requestAutoSuggestions()

shouldPopulateAutoSuggestions

protected boolean shouldPopulateAutoSuggestions(String query)

populateAutoSuggestions

protected void populateAutoSuggestions(String query)

initAutoSuggestionAndAutoCorrectionComponents

protected void initAutoSuggestionAndAutoCorrectionComponents()

getAutosuggestionBandpopup

protected org.zkoss.zul.Bandpopup getAutosuggestionBandpopup()

setAutosuggestionBandpopup

protected void setAutosuggestionBandpopup(org.zkoss.zul.Bandpopup autosuggestionBandpopup)

getAutosuggestionListbox

protected org.zkoss.zul.Listbox getAutosuggestionListbox()

setAutosuggestionListbox

protected void setAutosuggestionListbox(org.zkoss.zul.Listbox autosuggestionListbox)

processAutoSuggestions

protected void processAutoSuggestions(Map<String,Collection> autoSuggestions)

isSearchBoxOrRelatedViewsNull

protected boolean isSearchBoxOrRelatedViewsNull()

clearSearchBoxAndRelatedViews

protected void clearSearchBoxAndRelatedViews()

getCompleteSuggestion

protected String getCompleteSuggestion(String searchedPhraseWithoutLastWord,
                                       String suggestion)

clearSearchBox

@Deprecated
protected void clearSearchBox()

Deprecated. since 6.7, the method will not be used anymore

createListenerForBandPopup

protected void createListenerForBandPopup()

openSearchBoxWithBandPopup

protected void openSearchBoxWithBandPopup()

loadDataTypeForCode

protected DataType loadDataTypeForCode(String typeCode)

processFullTextSearchData

protected void processFullTextSearchData(FullTextSearchData fullTextSearchData)

setActionSlotTypeCode

protected void setActionSlotTypeCode(String typeCode)

canReadType

@Deprecated
protected boolean canReadType(String typeCode)

Deprecated. since 6.7, the method will not be used anymore

adjustWidgetModel

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

doSimpleSearch

protected abstract boolean doSimpleSearch()

getSearchText

protected String getSearchText()

isSimpleSearchActive

protected boolean isSimpleSearchActive()

buildQueryData

protected AdvancedSearchData buildQueryData(String searchText,
                                            String typeCode)

applySimpleSearchConfiguration

protected void applySimpleSearchConfiguration(String searchText,
                                              String typeCode,
                                              AdvancedSearchData queryData)

loadSimpleConfiguration

protected SimpleSearch loadSimpleConfiguration(String type)

createAdvancedSearchDataWithInitContext

protected AdvancedSearchData createAdvancedSearchDataWithInitContext()

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

Returns:

the new instance of AdvancedSearchData.

loadConfiguration

protected <T> T loadConfiguration(String type,
                                  String configurationContextCode,
                                  Class<T> configurationClass)

loadConfiguration

protected <T> T loadConfiguration(ConfigContext configurationContext,
                                  Class<T> configurationClass)

getActionSlot

protected Actions getActionSlot()

setActionSlot

protected void setActionSlot(Actions actionSlot)

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getLabelService

@Deprecated
protected LabelService getLabelService()

Deprecated. since 6.7, will be removed in the future.