Package org.opencms.workplace.tools.searchindex.sourcesearch

Class CmsSourceSearchCollector

java.lang.Object

org.opencms.workplace.list.A_CmsListResourceCollector

org.opencms.workplace.tools.searchindex.sourcesearch.CmsSourceSearchCollector

All Implemented Interfaces:

Comparable<org.opencms.file.collectors.I_CmsResourceCollector>, org.opencms.file.collectors.I_CmsCollectorPublishListProvider, org.opencms.file.collectors.I_CmsResourceCollector, I_CmsListResourceCollector

public class CmsSourceSearchCollector
extends A_CmsListResourceCollector

Collector for CmsResource resources to do source search in.

Since:

7.5.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTOR_NAME	Parameter of the default collector name.

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

Fields inherited from interface org.opencms.file.collectors.I_CmsResourceCollector

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
CmsSourceSearchCollector(CmsSourceSearchFilesDialog wp)	Constructor, creates a new instance.

Method Summary

Modifier and Type	Method	Description
List<String>	getCollectorNames()
org.opencms.file.CmsResource	getResource(org.opencms.file.CmsObject cms, CmsListItem item)	Returns the resource for the given item.
List<org.opencms.file.CmsResource>	getResources(org.opencms.file.CmsObject cms, Map params)	Returns all, unsorted and unfiltered, resources.
protected void	setAdditionalColumns(CmsListItem item, org.opencms.workplace.explorer.CmsResourceUtil resUtil)	Set additional column entries for a resource.

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

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

Methods inherited from class java.lang.Object

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

Field Details

COLLECTOR_NAME

public static final String COLLECTOR_NAME

Parameter of the default collector name.

See Also:

• Constant Field Values

Constructor Details

CmsSourceSearchCollector

public CmsSourceSearchCollector(CmsSourceSearchFilesDialog wp)

Constructor, creates a new instance.

Parameters:

wp - the workplace object

Method Details

getCollectorNames

public List<String> getCollectorNames()

See Also:

• I_CmsResourceCollector.getCollectorNames()

getResource

public org.opencms.file.CmsResource getResource(org.opencms.file.CmsObject cms,
 CmsListItem item)

Returns the resource for the given item.

Specified by:

getResource in interface I_CmsListResourceCollector

Overrides:

getResource in class A_CmsListResourceCollector

Parameters:

cms - the cms object

item - the item

Returns:

the resource

getResources

public List<org.opencms.file.CmsResource> getResources(org.opencms.file.CmsObject cms,
 Map params)
                                                throws org.opencms.main.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:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsListResourceCollector.getResources(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 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)