org.opencms.file.collectors

类 CmsCategoryResourceCollector

java.lang.Object

org.opencms.file.collectors.A_CmsResourceCollector

org.opencms.file.collectors.CmsCategoryResourceCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector

public class CmsCategoryResourceCollector
extends A_CmsResourceCollector

A collector to fetch XML contents in a folder or the current site filtered by one or more given category types.

The return list will also be filtered by given key value pairs which are given as a collector parameter.

Usage: <cms:contentload collector="allKeyValuePairFiltered" param="resource=[filename]|resourceType=[resource type]|categoryTypes=[category1,category2,...]|subTree=[boolean]|sortBy=[category|date|property:[property_name]]|sortAsc=[boolean]">

从以下版本开始:

7.0.0

字段概要

字段

限定符和类型	字段和说明
static java.util.Comparator<CmsResource>	COMPARE_DATE_RELEASED_DESC Compares the release date of resources in descending order.
protected static org.apache.commons.logging.Log	LOG The log object for this class.

从类继承的字段 org.opencms.file.collectors.A_CmsResourceCollector

m_order, SEPARATOR_TEMPLATEFILE

构造器概要

构造器

构造器和说明
CmsCategoryResourceCollector()

方法概要

方法

限定符和类型	方法和说明
protected java.util.List<CmsResource>	allKeyValuePairFiltered(CmsObject cms, java.lang.String param) Collects all resources for the given categories filtered and sorted by the given collector parameter.
java.util.List<java.lang.String>	getCollectorNames() Returns a list of all collector names (Strings) this collector implementation supports.
java.lang.String	getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.
java.lang.String	getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.
java.util.List<CmsResource>	getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.

从类继承的方法 org.opencms.file.collectors.A_CmsResourceCollector

checkParams, compareTo, createResourceForCollector, equals, getCreateInFolder, getCreateInFolder, getCreateLink, getCreateParam, getCreateTypeId, getDefaultCollectorName, getDefaultCollectorParam, getOrder, getResults, hashCode, setDefaultCollectorName, setDefaultCollectorParam, setOrder, shrinkToFit

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

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

字段详细资料

COMPARE_DATE_RELEASED_DESC

public static final java.util.Comparator<CmsResource> COMPARE_DATE_RELEASED_DESC

Compares the release date of resources in descending order.

LOG

protected static final org.apache.commons.logging.Log LOG

The log object for this class.

构造器详细资料

CmsCategoryResourceCollector

public CmsCategoryResourceCollector()

方法详细资料

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()

getCreateLink

public java.lang.String getCreateLink(CmsObject cms,
                             java.lang.String collectorName,
                             java.lang.String param)
                               throws CmsException,
                                      CmsDataAccessException

从接口复制的说明: I_CmsResourceCollector

Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.

If this method returns null, it indicated that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the link to execute after a "new" button was clicked

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

I_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getCreateParam

public java.lang.String getCreateParam(CmsObject cms,
                              java.lang.String collectorName,
                              java.lang.String param)
                                throws CmsDataAccessException

从接口复制的说明: I_CmsResourceCollector

Returns the parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.

If this method returns null, it indicates that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter from the current page context

返回:

the parameter that will be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method, or null

抛出:

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

I_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getResults

public java.util.List<CmsResource> getResults(CmsObject cms,
                                     java.lang.String collectorName,
                                     java.lang.String param)
                                       throws CmsDataAccessException,
                                              CmsException

从接口复制的说明: I_CmsResourceCollector

Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

a list of CmsXmlContent objects

抛出:

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

CmsException - if something goes wrong

另请参阅:

I_CmsResourceCollector.getResults(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

allKeyValuePairFiltered

protected java.util.List<CmsResource> allKeyValuePairFiltered(CmsObject cms,
                                                  java.lang.String param)
                                                       throws CmsException

Collects all resources for the given categories filtered and sorted by the given collector parameter.

参数:

cms - the current OpenCms user context

param - value parameter to filter the resources

返回:

a list of resources filtered and sorted by the given collector parameter

抛出:

CmsException - if something goes wrong