org.opencms.file.collectors

类 CmsDefaultResourceCollector

java.lang.Object

org.opencms.file.collectors.A_CmsResourceCollector

org.opencms.file.collectors.CmsDefaultResourceCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector

public class CmsDefaultResourceCollector
extends A_CmsResourceCollector

A default resource collector to generate some example list of resources from the VFS.

从以下版本开始:

6.0.0

字段概要

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

m_order, SEPARATOR_TEMPLATEFILE

构造器概要

构造器

构造器和说明
CmsDefaultResourceCollector()

方法概要

方法

限定符和类型	方法和说明
protected java.util.List<CmsResource>	allInFolderDateReleasedDesc(CmsObject cms, java.lang.String param, boolean tree) Returns a List of all resources in the folder pointed to by the parameter sorted by the release date, descending.
protected java.util.List<CmsResource>	allInFolderNavPos(CmsObject cms, java.lang.String param, boolean readSubTree) Collects all resources in a folder (or subtree) sorted by the NavPos property.
protected java.util.List<CmsResource>	getAllInFolder(CmsObject cms, java.lang.String param, boolean tree) Returns all resources in the folder pointed to by the 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.
int	getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the id of the resource type for new collector items.
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.
protected java.util.List<CmsResource>	getSingleFile(CmsObject cms, java.lang.String param) Returns a List containing the resources pointed to by the parameter.

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

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

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

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

构造器详细资料

CmsDefaultResourceCollector

public CmsDefaultResourceCollector()

方法详细资料

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 CmsDataAccessException,
                                      CmsException

从接口复制的说明: 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

抛出:

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

CmsException - if something goes wrong

另请参阅:

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)

getCreateTypeId

public int getCreateTypeId(CmsObject cms,
                  java.lang.String collectorName,
                  java.lang.String param)

从接口复制的说明: I_CmsResourceCollector

Returns the id of the resource type for new collector items.

Returns -1 if creation of new items is not supported.

指定者:

getCreateTypeId 在接口中 I_CmsResourceCollector

覆盖:

getCreateTypeId 在类中 A_CmsResourceCollector

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the resource type id

另请参阅:

A_CmsResourceCollector.getCreateTypeId(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)

allInFolderDateReleasedDesc

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

Returns a List of all resources in the folder pointed to by the parameter sorted by the release date, descending.

参数:

cms - the current CmsObject

param - the folder name to use

tree - if true, look in folder and all child folders, if false, look only in given folder

返回:

a List of all resources in the folder pointed to by the parameter sorted by the release date, descending

抛出:

CmsException - if something goes wrong

allInFolderNavPos

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

Collects all resources in a folder (or subtree) sorted by the NavPos property.

参数:

cms - the current user's Cms object

param - the collector's parameter(s)

readSubTree - if true, collects all resources in the subtree

返回:

a List of Cms resources found by the collector

抛出:

CmsException - if something goes wrong

getAllInFolder

protected java.util.List<CmsResource> getAllInFolder(CmsObject cms,
                                         java.lang.String param,
                                         boolean tree)
                                              throws CmsException,
                                                     CmsIllegalArgumentException

Returns all resources in the folder pointed to by the parameter.

参数:

cms - the current OpenCms user context

param - the folder name to use

tree - if true, look in folder and all child folders, if false, look only in given folder

返回:

all resources in the folder matching the given criteria

抛出:

CmsException - if something goes wrong

CmsIllegalArgumentException - if the given param argument is not a link to a single file

getSingleFile

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

Returns a List containing the resources pointed to by the parameter.

参数:

cms - the current CmsObject

param - the name of the file to load

返回:

a List containing the resources pointed to by the parameter

抛出:

CmsException - if something goes wrong