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, I_CmsResourceCollector, I_CmsListResourceCollector

public class CmsSearchResourcesCollector
extends A_CmsListResourceCollector

Collector for receiving CmsResources from a search result set.

Since:

6.1.0

Version:

$Revision: 1.9 $

Author:

Michael Moossen

Field Summary

static java.lang.String	COLLECTOR_NAME Parameter of the default collector name.
protected java.util.Map	m_srCache Resource cache.
static java.lang.String	PARAM_FIELDS Meta Parameter 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

CmsSearchResourcesCollector(A_CmsListExplorerDialog wp, java.lang.String query, java.lang.String sort, java.lang.String fields, java.util.List searchRoots, java.lang.String minCreationDate, java.lang.String maxCreationDate, java.lang.String minLastModificationDate, java.lang.String maxLastModificationDate)
Constructor, creates a new instance.

Method Summary

java.util.List	getCollectorNames() Returns a list of all collector names (Strings) this collector implementation supports.
protected java.util.List	getInternalResources(CmsObject cms, java.util.Map params) Wrapper method for caching the result of A_CmsListResourceCollector.getResources(CmsObject, Map).
java.util.List	getResources(CmsObject cms, java.util.Map 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.

Methods inherited from class org.opencms.workplace.list.A_CmsListResourceCollector

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

Methods inherited from class java.lang.Object

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

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_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 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 searchRoots,
                                   java.lang.String minCreationDate,
                                   java.lang.String maxCreationDate,
                                   java.lang.String minLastModificationDate,
                                   java.lang.String maxLastModificationDate)

Constructor, creates a new instance.

Parameters:

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

Method Detail

getCollectorNames

public java.util.List getCollectorNames()

Description copied from interface: I_CmsResourceCollector

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

Returns:

a list of all collector names this collector implementation supports

See Also:

I_CmsResourceCollector.getCollectorNames()

getResources

public java.util.List getResources(CmsObject cms,
                                   java.util.Map params)
                            throws CmsException

Description copied from class: A_CmsListResourceCollector

Returns all, unsorted and unfiltered, resources.

Be sure to cache the resources.

Specified by:

getResources in interface I_CmsListResourceCollector

Specified by:

getResources in class A_CmsListResourceCollector

Parameters:

cms - the cms object

params - the parameter map

Returns:

a list of CmsResource objects

Throws:

CmsException - if something goes wrong

See Also:

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.

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 interface I_CmsListResourceCollector

Overrides:

setPage in class A_CmsListResourceCollector

Parameters:

page - the new display page

See Also:

A_CmsListResourceCollector.setPage(int)

getInternalResources

protected java.util.List getInternalResources(CmsObject cms,
                                              java.util.Map params)
                                       throws CmsException

Description copied from class: A_CmsListResourceCollector

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

Overrides:

getInternalResources in class A_CmsListResourceCollector

Parameters:

cms - the cms object

params - the parameter map

Returns:

the result of A_CmsListResourceCollector.getResources(CmsObject, Map)

Throws:

CmsException - if something goes wrong

See Also:

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

setAdditionalColumns

protected void setAdditionalColumns(CmsListItem item,
                                    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 class A_CmsListResourceCollector

Parameters:

item - the current list item

resUtil - the resource util object for getting the info from

See Also:

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