org.opencms.workplace.search

类 CmsSearchResourcesCollector

java.lang.Object

org.opencms.workplace.list.A_CmsListResourceCollector

org.opencms.workplace.search.CmsSearchResourcesCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector, I_CmsListResourceCollector

public class CmsSearchResourcesCollector
extends A_CmsListResourceCollector

Collector for receiving CmsResources from a search result set.

从以下版本开始:

6.1.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	COLLECTOR_NAME Parameter of the default collector name.
protected java.util.Map<java.lang.String,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.

从类继承的字段 org.opencms.workplace.list.A_CmsListResourceCollector

m_collectorParameter, m_liCache, m_resCache, m_resources, VFS_PATH_NONE

从接口继承的字段 org.opencms.workplace.list.I_CmsListResourceCollector

PARAM_FILTER, PARAM_ORDER, PARAM_PAGE, PARAM_RESOURCES, PARAM_SORTBY, SEP_KEYVAL, SEP_PARAM

构造器概要

构造器

构造器和说明
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.

方法概要

方法

限定符和类型	方法和说明
java.util.List<java.lang.String>	getCollectorNames() Returns a list of all collector names (Strings) this collector implementation supports.
protected java.util.List<CmsResource>	getInternalResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Wrapper method for caching the result of A_CmsListResourceCollector.getResources(CmsObject, Map).
java.util.List<CmsResource>	getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns all, unsorted and unfiltered, resources.
CmsSearchResult	getSearchResult(java.lang.String structureId) Returns the search result object for the given structure id.
protected void	setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) Set additional column entries for a resource.
void	setPage(int page) Sets the current display page.

从类继承的方法 org.opencms.workplace.list.A_CmsListResourceCollector

compareTo, createResourceListItem, getCreateLink, getCreateLink, getCreateParam, getCreateParam, getCreateTypeId, getDefaultCollectorName, getDefaultCollectorParam, getDummyListItem, getListItems, getOrder, getResource, getResourceNamesFromParam, getResults, getResults, getState, getWp, setDefaultCollectorName, setDefaultCollectorParam, setOrder, setResourcesParam

从类继承的方法 java.lang.Object

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

字段详细资料

COLLECTOR_NAME

public static final java.lang.String COLLECTOR_NAME

Parameter of the default collector name.

另请参阅:

常量字段值

PARAM_FIELDS

public static final java.lang.String PARAM_FIELDS

Meta Parameter name constant.

另请参阅:

常量字段值

PARAM_INDEXNAME

public static final java.lang.String PARAM_INDEXNAME

Meta Parameter index name constant.

另请参阅:

常量字段值

PARAM_MAXCREATIONDATE

public static final java.lang.String PARAM_MAXCREATIONDATE

Maximum creation date parameter name constant.

另请参阅:

常量字段值

PARAM_MAXLASTMODIFICATIONDATE

public static final java.lang.String PARAM_MAXLASTMODIFICATIONDATE

Maximum last modification date parameter name constant.

另请参阅:

常量字段值

PARAM_MINCREATIONDATE

public static final java.lang.String PARAM_MINCREATIONDATE

Minimum creation date parameter name constant.

另请参阅:

常量字段值

PARAM_MINLASTMODIFICATIONDATE

public static final java.lang.String PARAM_MINLASTMODIFICATIONDATE

Minimum last modification date parameter name constant.

另请参阅:

常量字段值

PARAM_QUERY

public static final java.lang.String PARAM_QUERY

Query Parameter name constant.

另请参阅:

常量字段值

PARAM_SORT

public static final java.lang.String PARAM_SORT

Sort Parameter name constant.

另请参阅:

常量字段值

m_srCache

protected java.util.Map<java.lang.String,CmsSearchResult> m_srCache

Resource cache.

构造器详细资料

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.

参数:

wp - the workplace object

query - the search query

sort - the sort by parameter

fields - the comma separated list of fields to search

searchRoots - a list of search roots

minCreationDate - the minimum creation date of the resources to be searched

maxCreationDate - the maximum creation date of the resources to be searched

minLastModificationDate - the minimum creation date of the resources to be searched

maxLastModificationDate - the maximum creation date of the resources to be searched

indexName - the index name to search in

方法详细资料

getCollectorNames

public java.util.List<java.lang.String> getCollectorNames()

从接口复制的说明: I_CmsResourceCollector

Returns a list of all collector names (Strings) this collector implementation supports.

返回:

a list of all collector names this collector implementation supports

另请参阅:

I_CmsResourceCollector.getCollectorNames()

getResources

public java.util.List<CmsResource> getResources(CmsObject cms,
                                       java.util.Map<java.lang.String,java.lang.String> params)
                                         throws CmsException

从类复制的说明: A_CmsListResourceCollector

Returns all, unsorted and unfiltered, resources.

Be sure to cache the resources.

指定者:

getResources 在接口中 I_CmsListResourceCollector

指定者:

getResources 在类中 A_CmsListResourceCollector

参数:

cms - the cms object

params - the parameter map

返回:

a list of CmsResource objects

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsListResourceCollector.getResources(org.opencms.file.CmsObject, java.util.Map)

getSearchResult

public CmsSearchResult getSearchResult(java.lang.String structureId)

Returns the search result object for the given structure id.

参数:

structureId - the structure id

返回:

the resource

setPage

public void setPage(int page)

从类复制的说明: A_CmsListResourceCollector

Sets the current display page.

指定者:

setPage 在接口中 I_CmsListResourceCollector

覆盖:

setPage 在类中 A_CmsListResourceCollector

参数:

page - the new display page

另请参阅:

A_CmsListResourceCollector.setPage(int)

getInternalResources

protected java.util.List<CmsResource> getInternalResources(CmsObject cms,
                                               java.util.Map<java.lang.String,java.lang.String> params)
                                                    throws CmsException

从类复制的说明: A_CmsListResourceCollector

Wrapper method for caching the result of A_CmsListResourceCollector.getResources(CmsObject, Map).

覆盖:

getInternalResources 在类中 A_CmsListResourceCollector

参数:

cms - the cms object

params - the parameter map

返回:

the result of A_CmsListResourceCollector.getResources(CmsObject, Map)

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsListResourceCollector.getInternalResources(org.opencms.file.CmsObject, java.util.Map)

setAdditionalColumns

protected void setAdditionalColumns(CmsListItem item,
                        CmsResourceUtil resUtil)

从类复制的说明: A_CmsListResourceCollector

Set additional column entries for a resource.

Overwrite this method to set additional column entries.

指定者:

setAdditionalColumns 在类中 A_CmsListResourceCollector

参数:

item - the current list item

resUtil - the resource util object for getting the info from

另请参阅:

A_CmsListResourceCollector.setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)