|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.file.collectors.A_CmsResourceCollector
org.opencms.file.collectors.CmsTimeFrameCategoryCollector
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| 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:
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.
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.
System.currentTimeMillis()
syntax for the validity time frame
check.
All other key - value pairs are ignored.
Field Summary | |
static java.text.DateFormat |
DATEFORMAT_SQL
SQL Standard date format: "yyyy-MM-dd HH:mm:ss". |
Fields inherited from class org.opencms.file.collectors.A_CmsResourceCollector |
m_order |
Constructor Summary | |
CmsTimeFrameCategoryCollector()
Public constructor. |
Method Summary | |
java.util.List |
getCollectorNames()
Returns a list of all collector names (Strings) this collector implementation supports. |
protected java.lang.String |
getCreateInFolder(CmsObject cms,
CmsCollectorData data)
Returns the link to create a new XML content item in the folder pointed to by the parameter. |
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 getCreateLink(CmsObject, String, String) method. |
java.util.List |
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. |
Methods inherited from class org.opencms.file.collectors.A_CmsResourceCollector |
checkParams, compareTo, equals, getCreateInFolder, getCreateLink, getCreateParam, getDefaultCollectorName, getDefaultCollectorParam, getOrder, getResults, hashCode, setDefaultCollectorName, setDefaultCollectorParam, setOrder, shrinkToFit |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.text.DateFormat DATEFORMAT_SQL
Constructor Detail |
public CmsTimeFrameCategoryCollector()
Method Detail |
public java.util.List getCollectorNames()
I_CmsResourceCollector
I_CmsResourceCollector.getCollectorNames()
protected java.lang.String getCreateInFolder(CmsObject cms, CmsCollectorData data) throws CmsException
A_CmsResourceCollector
getCreateInFolder
in class A_CmsResourceCollector
cms
- the current CmsObjectdata
- the collector data to use
CmsException
- if something goes wrongA_CmsResourceCollector.getCreateInFolder(org.opencms.file.CmsObject, org.opencms.file.collectors.CmsCollectorData)
public java.lang.String getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsException, CmsDataAccessException
I_CmsResourceCollector
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 CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
CmsException
- if something goes wrong
CmsDataAccessException
- if the parameter attribute of the corresponding collector tag is invalidI_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
public java.lang.String getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
I_CmsResourceCollector
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 CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter from the current page context
I_CmsResourceCollector.getCreateLink(CmsObject, String, String)
method, or nullI_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
public java.util.List getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsDataAccessException, CmsException
I_CmsResourceCollector
CmsResource
Objects that are
gathered in the VFS using the named collector.
cms
- the current CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
CmsException
- if something goes wrong
CmsDataAccessException
- if the parameter attribute of the corresponding collector tag is invalidI_CmsResourceCollector.getResults(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |