Package org.opencms.workplace.search
Class CmsSearchResourcesCollector
- java.lang.Object
-
- org.opencms.workplace.list.A_CmsListResourceCollector
-
- org.opencms.workplace.search.CmsSearchResourcesCollector
-
- All Implemented Interfaces:
java.lang.Comparable<org.opencms.file.collectors.I_CmsResourceCollector>
,org.opencms.file.collectors.I_CmsCollectorPublishListProvider
,org.opencms.file.collectors.I_CmsResourceCollector
,I_CmsListResourceCollector
public class CmsSearchResourcesCollector extends A_CmsListResourceCollector
Collector for receiving CmsResources from a search result set.- Since:
- 6.1.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COLLECTOR_NAME
Parameter of the default collector name.protected java.util.Map<java.lang.String,org.opencms.search.CmsSearchResult>
m_srCache
Resource cache.static java.lang.String
PARAM_FIELDS
Meta Parameter name constant.static java.lang.String
PARAM_INDEXNAME
Meta Parameter index name constant.static java.lang.String
PARAM_MAXCREATIONDATE
Maximum creation date parameter name constant.static java.lang.String
PARAM_MAXLASTMODIFICATIONDATE
Maximum last modification date parameter name constant.static java.lang.String
PARAM_MINCREATIONDATE
Minimum creation date parameter name constant.static java.lang.String
PARAM_MINLASTMODIFICATIONDATE
Minimum last modification date parameter name constant.static java.lang.String
PARAM_QUERY
Query Parameter name constant.static java.lang.String
PARAM_SORT
Sort Parameter name constant.-
Fields inherited from class org.opencms.workplace.list.A_CmsListResourceCollector
m_collectorParameter, m_liCache, m_resCache, m_resources, VFS_PATH_NONE
-
Fields inherited from interface org.opencms.workplace.list.I_CmsListResourceCollector
PARAM_FILTER, PARAM_ORDER, PARAM_PAGE, PARAM_RESOURCES, PARAM_SORTBY, SEP_KEYVAL, SEP_PARAM
-
-
Constructor Summary
Constructors Constructor Description CmsSearchResourcesCollector(A_CmsListExplorerDialog wp, java.lang.String query, java.lang.String sort, java.lang.String fields, java.util.List<java.lang.String> searchRoots, java.lang.String minCreationDate, java.lang.String maxCreationDate, java.lang.String minLastModificationDate, java.lang.String maxLastModificationDate, java.lang.String indexName)
Constructor, creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>
getCollectorNames()
protected java.util.List<org.opencms.file.CmsResource>
getInternalResources(org.opencms.file.CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
Wrapper method for caching the result ofA_CmsListResourceCollector.getResources(CmsObject, Map)
.java.util.List<org.opencms.file.CmsResource>
getResources(org.opencms.file.CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
Returns all, unsorted and unfiltered, resources.org.opencms.search.CmsSearchResult
getSearchResult(java.lang.String structureId)
Returns the search result object for the given structure id.protected void
setAdditionalColumns(CmsListItem item, org.opencms.workplace.explorer.CmsResourceUtil resUtil)
Set additional column entries for a resource.void
setPage(int page)
Sets the current display page.-
Methods inherited from class org.opencms.workplace.list.A_CmsListResourceCollector
compareTo, createResourceListItem, getCreateLink, getCreateLink, getCreateParam, getCreateParam, getCreateTypeId, getDefaultCollectorName, getDefaultCollectorParam, getDummyListItem, getListItems, getOrder, getPublishResources, getResource, getResourceNamesFromParam, getResults, getResults, getResults, getState, getWp, setDefaultCollectorName, setDefaultCollectorParam, setOrder, setResourcesParam
-
-
-
-
Field Detail
-
COLLECTOR_NAME
public static final java.lang.String COLLECTOR_NAME
Parameter of the default collector name.- See Also:
- Constant Field Values
-
PARAM_FIELDS
public static final java.lang.String PARAM_FIELDS
Meta Parameter name constant.- See Also:
- Constant Field Values
-
PARAM_INDEXNAME
public static final java.lang.String PARAM_INDEXNAME
Meta Parameter index name constant.- See Also:
- Constant Field Values
-
PARAM_MAXCREATIONDATE
public static final java.lang.String PARAM_MAXCREATIONDATE
Maximum creation date parameter name constant.- See Also:
- Constant Field Values
-
PARAM_MAXLASTMODIFICATIONDATE
public static final java.lang.String PARAM_MAXLASTMODIFICATIONDATE
Maximum last modification date parameter name constant.- See Also:
- Constant Field Values
-
PARAM_MINCREATIONDATE
public static final java.lang.String PARAM_MINCREATIONDATE
Minimum creation date parameter name constant.- See Also:
- Constant Field Values
-
PARAM_MINLASTMODIFICATIONDATE
public static final java.lang.String PARAM_MINLASTMODIFICATIONDATE
Minimum last modification date parameter name constant.- See Also:
- Constant Field Values
-
PARAM_QUERY
public static final java.lang.String PARAM_QUERY
Query Parameter name constant.- See Also:
- Constant Field Values
-
PARAM_SORT
public static final java.lang.String PARAM_SORT
Sort Parameter name constant.- See Also:
- Constant Field Values
-
m_srCache
protected java.util.Map<java.lang.String,org.opencms.search.CmsSearchResult> m_srCache
Resource cache.
-
-
Constructor Detail
-
CmsSearchResourcesCollector
public CmsSearchResourcesCollector(A_CmsListExplorerDialog wp, java.lang.String query, java.lang.String sort, java.lang.String fields, java.util.List<java.lang.String> searchRoots, java.lang.String minCreationDate, java.lang.String maxCreationDate, java.lang.String minLastModificationDate, java.lang.String maxLastModificationDate, java.lang.String indexName)
Constructor, creates a new instance.- Parameters:
wp
- the workplace objectquery
- the search querysort
- the sort by parameterfields
- the comma separated list of fields to searchsearchRoots
- a list of search rootsminCreationDate
- the minimum creation date of the resources to be searchedmaxCreationDate
- the maximum creation date of the resources to be searchedminLastModificationDate
- the minimum creation date of the resources to be searchedmaxLastModificationDate
- the maximum creation date of the resources to be searchedindexName
- the index name to search in
-
-
Method Detail
-
getCollectorNames
public java.util.List<java.lang.String> getCollectorNames()
- See Also:
I_CmsResourceCollector.getCollectorNames()
-
getResources
public java.util.List<org.opencms.file.CmsResource> getResources(org.opencms.file.CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
Description copied from class:A_CmsListResourceCollector
Returns all, unsorted and unfiltered, resources.Be sure to cache the resources.
- Specified by:
getResources
in interfaceI_CmsListResourceCollector
- Specified by:
getResources
in classA_CmsListResourceCollector
- Parameters:
cms
- the cms objectparams
- the parameter map- Returns:
- a list of
CmsResource
objects - See Also:
A_CmsListResourceCollector.getResources(org.opencms.file.CmsObject, java.util.Map)
-
getSearchResult
public org.opencms.search.CmsSearchResult getSearchResult(java.lang.String structureId)
Returns the search result object for the given structure id.- Parameters:
structureId
- the structure id- Returns:
- the resource
-
setPage
public void setPage(int page)
Description copied from class:A_CmsListResourceCollector
Sets the current display page.- Specified by:
setPage
in interfaceI_CmsListResourceCollector
- Overrides:
setPage
in classA_CmsListResourceCollector
- Parameters:
page
- the new display page- See Also:
A_CmsListResourceCollector.setPage(int)
-
getInternalResources
protected java.util.List<org.opencms.file.CmsResource> getInternalResources(org.opencms.file.CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
Description copied from class:A_CmsListResourceCollector
Wrapper method for caching the result ofA_CmsListResourceCollector.getResources(CmsObject, Map)
.- Overrides:
getInternalResources
in classA_CmsListResourceCollector
- Parameters:
cms
- the cms objectparams
- the parameter map- Returns:
- the result of
A_CmsListResourceCollector.getResources(CmsObject, Map)
- See Also:
A_CmsListResourceCollector.getInternalResources(org.opencms.file.CmsObject, java.util.Map)
-
setAdditionalColumns
protected void setAdditionalColumns(CmsListItem item, org.opencms.workplace.explorer.CmsResourceUtil resUtil)
Description copied from class:A_CmsListResourceCollector
Set additional column entries for a resource.Overwrite this method to set additional column entries.
- Specified by:
setAdditionalColumns
in classA_CmsListResourceCollector
- Parameters:
item
- the current list itemresUtil
- the resource util object for getting the info from- See Also:
A_CmsListResourceCollector.setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)
-
-