org.opencms.file.collectors

类 CmsTimeFrameCategoryCollector

java.lang.Object

org.opencms.file.collectors.A_CmsResourceCollector

org.opencms.file.collectors.CmsTimeFrameCategoryCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector

public class CmsTimeFrameCategoryCollector
extends A_CmsResourceCollector

A collector that allows to collect resources within a time range based upon a configurable property that contains a time stamp.

Additionally a property may be specified that contains a comma separated list of category Strings that have to match the specified list of categories to allow.

Demo usage:

 <cms:contentload collector="timeFrameAndCategories" 
   param="
     resource=/de/events/|
     resourceType=xmlcontent|
     resultLimit=10|
     sortDescending=true|
     excludeTimerange=true|
     timeStart=2007-08-01 14:22:12|
     timeEnd=2007-08-01 14:22:12|
     propertyTime=collector.time|
     propertyCategories=collector.categories|
     categories=sports,action,lifestyle"
   >
 

The param attribute supports a key - value syntax for collector params.

All parameters are specified as follows:

 key=value
 

Many key - value pairs may exist:

 key=value|key2=value2|key3=value3
 

The following keys are reserved:

• resource
  The value defines the folder / single file for collection of results.
• resourceType
  The value defines the name of the type of resource that is required for the result as defined in opencms-modules.xml, opencms-workplace.xml.
• resultLimit
  The value defines the maximum amount of results to return.
• sortDescending
  The value defines if the result is sorted in descending ("true") or ascending (anything else than "true") order.
• excludeTimeRange
  The value defines if the result should exclude the time range in an offline project.
• timeStart
  The value defines the start time in the format yyyy-MM-dd HH:mm:ss as known by the description of SimpleDateFormat that will be used for the validity time frame of result candidates.
• timeEnd
  The value defines the end time in the format yyyy-MM-dd HH:mm:ss as known by the description of SimpleDateFormat that will be used for the validity time frame of result candidates.
• propertyTime
  The value defines the name of the property that is inspected for a time stamp in System.currentTimeMillis() syntax for the validity time frame check.
• propertyCategories
  The value defines the name of the property that is inspected for a pipe separated list of category strings.
• categories
  The value defines a list of comma separated category Strings used to filter result candidates by. If this parameter is missing completely no category filtering will be done and also resources with empty category property will be accepted.

All other key - value pairs are ignored.

从以下版本开始:

7.0.3

字段概要

字段

限定符和类型	字段和说明
static java.text.DateFormat	DATEFORMAT_SQL SQL Standard date format: "yyyy-MM-dd HH:mm:ss".

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

m_order, SEPARATOR_TEMPLATEFILE

构造器概要

构造器

构造器和说明
CmsTimeFrameCategoryCollector() Public constructor.

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 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

字段详细资料

DATEFORMAT_SQL

public static final java.text.DateFormat DATEFORMAT_SQL

SQL Standard date format: "yyyy-MM-dd HH:mm:ss".

构造器详细资料

CmsTimeFrameCategoryCollector

public CmsTimeFrameCategoryCollector()

Public constructor.

方法详细资料

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)

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

另请参阅:

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)
                    throws CmsException

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

抛出:

CmsException - if something goes wrong

另请参阅:

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)