de.hybris.platform.cockpit.session.impl

Class AbstractSearchBrowserModel

java.lang.Object

de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

de.hybris.platform.cockpit.session.impl.AbstractPageableBrowserModel

de.hybris.platform.cockpit.session.impl.AbstractSearchBrowserModel

All Implemented Interfaces:

AdvancedBrowserModel, BrowserModel, CockpitListComponent<TypedObject>, CockpitListComponentExt<TypedObject>, PageableBrowserModel, SearchBrowserModel, Cloneable

Direct Known Subclasses:

DefaultSearchBrowserModel

public abstract class AbstractSearchBrowserModel
extends AbstractPageableBrowserModel
implements SearchBrowserModel

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADVANCED_SEARCH_CONF
protected DefaultAdvancedSearchModel	advancedSearchModel
static String	PATH_DELIMITER
static String	PATH_LIST_DELIMITER
static String	QUERY_PATH_DELIMITER

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

contextItems, LIST_VIEW_CONFIG_CODE, viewMode

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

browserListeners, cacheView, rootType, VIEWMODE_GRID, VIEWMODE_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractSearchBrowserModel(ObjectTemplate rootType)

Method Summary

Modifier and Type	Method and Description
void	addBrowserModelListener(BrowserModelListener listener)
void	collapse()
protected void	fireAdvancedSearchVisibilityChanged()
AdvancedSearchModel	getAdvancedSearchModel()
Set<BrowserFilter>	getAvailableBrowserFilters()
protected Set<BrowserFilter>	getConfiguredBrowserFilters()
Query	getLastQuery()
ObjectTemplate	getLastType()
ExtendedSearchResult	getResult()
protected SearchType	getSearchType()
String	getSimpleQuery()
protected Map<PropertyDescriptor,Boolean>	getSortCriterion(Query query) Returns the sort criterion to be used for sorting.
abstract List<PropertyDescriptor>	getSortProperties()
protected UIConfigurationService	getUIConfigurationService()
boolean	isAdvancedHeaderDropdownSticky()
boolean	isAdvancedHeaderDropdownVisible()
boolean	isAdvancedSearchSticky()
boolean	isAdvancedSearchVisible()
boolean	isCollapsed()
void	setAdvancedSearchSticky(boolean sticky)
void	setAdvancedSearchVisible(boolean advancedSearchVisible)
void	setLastQuery(Query query)
void	setResult(ExtendedSearchResult result)
void	setRootType(ObjectTemplate rootType)
void	setSimpleQuery(String simpleQuery) Sets the simple search text to simpleQuery and - if advanced search is not visible - clears any set advanced search parameter values.
void	setSortableProperties(List<PropertyDescriptor> sortProps)
void	setSortAsc(boolean asc)
void	setSortedByProperty(PropertyDescriptor sortProp)
abstract void	updateItems(Query query)

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractPageableBrowserModel

addPageSize, firePagingChanged, getContextItemsPaged, getContextItemsPageIndex, getContextItemsPageSize, getCurrentPage, getLastPage, getMaxPageSize, getOffset, getPageSize, getPageSizes, hasStatusBar, isSimplePaging, setContextItemsDirectly, setContextItemsPageIndex, setContextItemsPageSize, setCurrentPage, setMaxPageSize, setOffset, setPageSize, setPageSizes, setSimplePaging, updateItems, updateItems

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

doDrop, fireContextItemsChanged, fireContextRootTypeChanged, fireContextSelectionChanged, fireContextViewModeChanged, fireContextVisibilityChanged, fireItemActivated, fireItemsDropped, fireViewModeChanged, getActiveItem, getAvailableViewModes, getCompareModel, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getListViewConfiguration, getSelectedContextIndexes, getTableModel, getViewMode, isContextItemsMovable, isContextItemsRemovable, isContextPropertyWritable, isContextVisible, isItemsMovable, isItemsRemovable, isPossibleAddContextSubTypes, setActiveItem, setCompareModel, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

clearSelection, clone, fireChanged, fireItemsChanged, fireRootTypeChanged, fireSelectionChanged, focus, getArea, getBrowserFilter, getBrowserFilterFixed, getCacheView, getExtendedLabel, getItem, getItems, getLabel, getRootType, getSelectedIndexes, getSelectedItems, getTotalCount, isAllMarked, isDuplicatable, isFocused, multiEdit, multiEdit, onClose, onHide, onShow, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setBrowserFilterFixed, setCacheView, setExtendedLabel, setLabel, setSelectedIndexes, setTotalCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.cockpit.session.PageableBrowserModel

addPageSize, getCurrentPage, getLastPage, getOffset, getPageSize, getPageSizes, isSimplePaging, setCurrentPage, setOffset, setPageSize, setSimplePaging, updateItems

Methods inherited from interface de.hybris.platform.cockpit.session.AdvancedBrowserModel

blacklistItems, doDrop, getActiveItem, getAvailableViewModes, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getSelectedContextIndexes, getTableModel, getViewMode, isContextItemsMovable, isContextItemsRemovable, isContextVisible, isItemsMovable, isItemsRemovable, removeItems, setActiveItem, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsDirectly, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

Methods inherited from interface de.hybris.platform.cockpit.session.BrowserModel

clone, createViewComponent, focus, getArea, getBrowserFilter, getExtendedLabel, getItem, getLabel, getRootType, getSelectedIndexes, getSelectedItems, getTotalCount, hasStatusBar, isAllMarked, isDuplicatable, isFocused, multiEdit, multiEdit, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setExtendedLabel, setLabel, setSelectedIndexes, setTotalCount, updateItems

Methods inherited from interface de.hybris.platform.cockpit.session.CockpitListComponent

getItems

Field Detail

QUERY_PATH_DELIMITER

public static final String QUERY_PATH_DELIMITER

See Also:

Constant Field Values

PATH_LIST_DELIMITER

public static final String PATH_LIST_DELIMITER

See Also:

Constant Field Values

PATH_DELIMITER

public static final String PATH_DELIMITER

See Also:

Constant Field Values

ADVANCED_SEARCH_CONF

protected static final String ADVANCED_SEARCH_CONF

See Also:

Constant Field Values

advancedSearchModel

protected DefaultAdvancedSearchModel advancedSearchModel

Constructor Detail

AbstractSearchBrowserModel

public AbstractSearchBrowserModel(ObjectTemplate rootType)

Method Detail

setRootType

public void setRootType(ObjectTemplate rootType)

Specified by:

setRootType in interface BrowserModel

Overrides:

setRootType in class AbstractBrowserModel

getLastType

public ObjectTemplate getLastType()

Specified by:

getLastType in interface AdvancedBrowserModel

Overrides:

getLastType in class AbstractAdvancedBrowserModel

setLastQuery

public void setLastQuery(Query query)

Specified by:

setLastQuery in interface SearchBrowserModel

getLastQuery

public Query getLastQuery()

Specified by:

getLastQuery in interface SearchBrowserModel

collapse

public void collapse()

Specified by:

collapse in interface BrowserModel

Overrides:

collapse in class AbstractAdvancedBrowserModel

isCollapsed

public boolean isCollapsed()

Specified by:

isCollapsed in interface BrowserModel

Overrides:

isCollapsed in class AbstractAdvancedBrowserModel

setResult

public void setResult(ExtendedSearchResult result)

Specified by:

setResult in interface SearchBrowserModel

getResult

public ExtendedSearchResult getResult()

Specified by:

getResult in interface SearchBrowserModel

setSortedByProperty

public void setSortedByProperty(PropertyDescriptor sortProp)

setSortAsc

public void setSortAsc(boolean asc)

setSortableProperties

public void setSortableProperties(List<PropertyDescriptor> sortProps)

getSimpleQuery

public String getSimpleQuery()

Specified by:

getSimpleQuery in interface SearchBrowserModel

setSimpleQuery

public void setSimpleQuery(String simpleQuery)

Description copied from interface: SearchBrowserModel

Sets the simple search text to simpleQuery and - if advanced search is not visible - clears any set advanced search parameter values.

Specified by:

setSimpleQuery in interface SearchBrowserModel

Parameters:

simpleQuery - the text to search for

getAdvancedSearchModel

public AdvancedSearchModel getAdvancedSearchModel()

Specified by:

getAdvancedSearchModel in interface SearchBrowserModel

isAdvancedSearchSticky

public boolean isAdvancedSearchSticky()

Specified by:

isAdvancedSearchSticky in interface SearchBrowserModel

setAdvancedSearchSticky

public void setAdvancedSearchSticky(boolean sticky)

Specified by:

setAdvancedSearchSticky in interface SearchBrowserModel

isAdvancedHeaderDropdownSticky

public boolean isAdvancedHeaderDropdownSticky()

Specified by:

isAdvancedHeaderDropdownSticky in interface BrowserModel

Overrides:

isAdvancedHeaderDropdownSticky in class AbstractBrowserModel

isAdvancedHeaderDropdownVisible

public boolean isAdvancedHeaderDropdownVisible()

Specified by:

isAdvancedHeaderDropdownVisible in interface BrowserModel

Overrides:

isAdvancedHeaderDropdownVisible in class AbstractBrowserModel

isAdvancedSearchVisible

public boolean isAdvancedSearchVisible()

Specified by:

isAdvancedSearchVisible in interface SearchBrowserModel

setAdvancedSearchVisible

public void setAdvancedSearchVisible(boolean advancedSearchVisible)

Specified by:

setAdvancedSearchVisible in interface SearchBrowserModel

getSortProperties

public abstract List<PropertyDescriptor> getSortProperties()

updateItems

public abstract void updateItems(Query query)

Specified by:

updateItems in interface SearchBrowserModel

fireAdvancedSearchVisibilityChanged

protected void fireAdvancedSearchVisibilityChanged()

getSortCriterion

protected Map<PropertyDescriptor,Boolean> getSortCriterion(Query query)

Returns the sort criterion to be used for sorting. The map which is returned will contain the first sort criterion which is held by both query and the AdvancedSearchModel returned by getAdvancedSearchModel(). If no such criterion can be found the property returned by AdvancedSearchModel.getSortedByProperty() will be returned as key with a corresponding value of true.

Parameters:

query - the query for which the sort criterion is to be extracted

Returns:

a singleton map with the key set to the PropertyDescriptor to be used for searching and the corresponding value set to the sort order (true means ascending) or an empty map if no sort criterion can be resolved

getSearchType

protected SearchType getSearchType()

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

addBrowserModelListener

public void addBrowserModelListener(BrowserModelListener listener)

Specified by:

addBrowserModelListener in interface BrowserModel

Overrides:

addBrowserModelListener in class AbstractPageableBrowserModel

getAvailableBrowserFilters

public Set<BrowserFilter> getAvailableBrowserFilters()

Specified by:

getAvailableBrowserFilters in interface BrowserModel

Overrides:

getAvailableBrowserFilters in class AbstractBrowserModel

getConfiguredBrowserFilters

protected Set<BrowserFilter> getConfiguredBrowserFilters()