Package org.opencms.workplace.tools.content.check

Class CmsContentCheckCollector

java.lang.Object

org.opencms.workplace.list.A_CmsListResourceCollector

org.opencms.workplace.tools.content.check.CmsContentCheckCollector

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 CmsContentCheckCollector
extends A_CmsListResourceCollector

Collector for receiving CmsResource objects from a CmsContentCheckResult.

Since:

6.1.2

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COLLECTOR_NAME	Parameter of the default collector name.
static java.lang.String	PARAM_ALL	Parameter to get all resources with errors and warnings.
static java.lang.String	PARAM_ERROR	Parameter to get all resources with errors.
static java.lang.String	PARAM_WARNING	Parameter to get all resources with warnings.

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
CmsContentCheckCollector(A_CmsListExplorerDialog wp, CmsContentCheckResult results)	Constructor, creates a new CmsContentCheckCollector.

Method Summary

Modifier and Type	Method	Description
java.util.List	getCollectorNames()
java.util.List	getResources(org.opencms.file.CmsObject cms, java.util.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, getResource, 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 Detail

COLLECTOR_NAME

public static final java.lang.String COLLECTOR_NAME

Parameter of the default collector name.

See Also:

Constant Field Values

PARAM_ALL

public static final java.lang.String PARAM_ALL

Parameter to get all resources with errors and warnings.

See Also:

Constant Field Values

PARAM_ERROR

public static final java.lang.String PARAM_ERROR

Parameter to get all resources with errors.

See Also:

Constant Field Values

PARAM_WARNING

public static final java.lang.String PARAM_WARNING

Parameter to get all resources with warnings.

See Also:

Constant Field Values

Constructor Detail

CmsContentCheckCollector

public CmsContentCheckCollector(A_CmsListExplorerDialog wp,
                                CmsContentCheckResult results)

Constructor, creates a new CmsContentCheckCollector.

Parameters:

wp - the workplace object

results - a CmsContentCheckResult object, containing the results of the content check.

Method Detail

getCollectorNames

public java.util.List getCollectorNames()

See Also:

I_CmsResourceCollector.getCollectorNames()

getResources

public java.util.List getResources(org.opencms.file.CmsObject cms,
                                   java.util.Map params)

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

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)