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
,java.lang.Cloneable
- Direct Known Subclasses:
DefaultSearchBrowserModel
public abstract class AbstractSearchBrowserModel extends AbstractPageableBrowserModel implements SearchBrowserModel
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
ADVANCED_SEARCH_CONF
protected DefaultAdvancedSearchModel
advancedSearchModel
static java.lang.String
PATH_DELIMITER
static java.lang.String
PATH_LIST_DELIMITER
static java.lang.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 Description AbstractSearchBrowserModel(ObjectTemplate rootType)
-
Method Summary
-
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.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
-
Methods inherited from interface de.hybris.platform.cockpit.session.PageableBrowserModel
addPageSize, getCurrentPage, getLastPage, getOffset, getPageSize, getPageSizes, isSimplePaging, setCurrentPage, setOffset, setPageSize, setSimplePaging, updateItems
-
-
-
-
Field Detail
-
QUERY_PATH_DELIMITER
public static final java.lang.String QUERY_PATH_DELIMITER
- See Also:
- Constant Field Values
-
PATH_LIST_DELIMITER
public static final java.lang.String PATH_LIST_DELIMITER
- See Also:
- Constant Field Values
-
PATH_DELIMITER
public static final java.lang.String PATH_DELIMITER
- See Also:
- Constant Field Values
-
ADVANCED_SEARCH_CONF
protected static final java.lang.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 interfaceBrowserModel
- Overrides:
setRootType
in classAbstractBrowserModel
-
getLastType
public ObjectTemplate getLastType()
- Specified by:
getLastType
in interfaceAdvancedBrowserModel
- Overrides:
getLastType
in classAbstractAdvancedBrowserModel
-
setLastQuery
public void setLastQuery(Query query)
- Specified by:
setLastQuery
in interfaceSearchBrowserModel
-
getLastQuery
public Query getLastQuery()
- Specified by:
getLastQuery
in interfaceSearchBrowserModel
-
collapse
public void collapse()
- Specified by:
collapse
in interfaceBrowserModel
- Overrides:
collapse
in classAbstractAdvancedBrowserModel
-
isCollapsed
public boolean isCollapsed()
- Specified by:
isCollapsed
in interfaceBrowserModel
- Overrides:
isCollapsed
in classAbstractAdvancedBrowserModel
-
setResult
public void setResult(ExtendedSearchResult result)
- Specified by:
setResult
in interfaceSearchBrowserModel
-
getResult
public ExtendedSearchResult getResult()
- Specified by:
getResult
in interfaceSearchBrowserModel
-
setSortedByProperty
public void setSortedByProperty(PropertyDescriptor sortProp)
-
setSortAsc
public void setSortAsc(boolean asc)
-
setSortableProperties
public void setSortableProperties(java.util.List<PropertyDescriptor> sortProps)
-
getSimpleQuery
public java.lang.String getSimpleQuery()
- Specified by:
getSimpleQuery
in interfaceSearchBrowserModel
-
setSimpleQuery
public void setSimpleQuery(java.lang.String simpleQuery)
Description copied from interface:SearchBrowserModel
Sets the simple search text tosimpleQuery
and - if advanced search is not visible - clears any set advanced search parameter values.- Specified by:
setSimpleQuery
in interfaceSearchBrowserModel
- Parameters:
simpleQuery
- the text to search for
-
getAdvancedSearchModel
public AdvancedSearchModel getAdvancedSearchModel()
- Specified by:
getAdvancedSearchModel
in interfaceSearchBrowserModel
-
isAdvancedSearchSticky
public boolean isAdvancedSearchSticky()
- Specified by:
isAdvancedSearchSticky
in interfaceSearchBrowserModel
-
setAdvancedSearchSticky
public void setAdvancedSearchSticky(boolean sticky)
- Specified by:
setAdvancedSearchSticky
in interfaceSearchBrowserModel
-
isAdvancedHeaderDropdownSticky
public boolean isAdvancedHeaderDropdownSticky()
- Specified by:
isAdvancedHeaderDropdownSticky
in interfaceBrowserModel
- Overrides:
isAdvancedHeaderDropdownSticky
in classAbstractBrowserModel
-
isAdvancedHeaderDropdownVisible
public boolean isAdvancedHeaderDropdownVisible()
- Specified by:
isAdvancedHeaderDropdownVisible
in interfaceBrowserModel
- Overrides:
isAdvancedHeaderDropdownVisible
in classAbstractBrowserModel
-
isAdvancedSearchVisible
public boolean isAdvancedSearchVisible()
- Specified by:
isAdvancedSearchVisible
in interfaceSearchBrowserModel
-
setAdvancedSearchVisible
public void setAdvancedSearchVisible(boolean advancedSearchVisible)
- Specified by:
setAdvancedSearchVisible
in interfaceSearchBrowserModel
-
getSortProperties
public abstract java.util.List<PropertyDescriptor> getSortProperties()
-
updateItems
public abstract void updateItems(Query query)
- Specified by:
updateItems
in interfaceSearchBrowserModel
-
fireAdvancedSearchVisibilityChanged
protected void fireAdvancedSearchVisibilityChanged()
-
getSortCriterion
protected java.util.Map<PropertyDescriptor,java.lang.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 bothquery
and theAdvancedSearchModel
returned bygetAdvancedSearchModel()
. If no such criterion can be found the property returned byAdvancedSearchModel.getSortedByProperty()
will be returned askey
with a correspondingvalue
oftrue
.- Parameters:
query
- the query for which the sort criterion is to be extracted- Returns:
- a singleton map with the
key
set to thePropertyDescriptor
to be used for searching and the correspondingvalue
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 interfaceBrowserModel
- Overrides:
addBrowserModelListener
in classAbstractPageableBrowserModel
-
getAvailableBrowserFilters
public java.util.Set<BrowserFilter> getAvailableBrowserFilters()
- Specified by:
getAvailableBrowserFilters
in interfaceBrowserModel
- Overrides:
getAvailableBrowserFilters
in classAbstractBrowserModel
-
getConfiguredBrowserFilters
protected java.util.Set<BrowserFilter> getConfiguredBrowserFilters()
-
-