|
||||||
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.CmsPriorityResourceCollector
public class CmsPriorityResourceCollector
A collector to fetch sorted XML contents in a folder or subtree based on their priority and date or title values.
The date or title information has to be stored as property for each resource.
Field Summary | |
---|---|
static int |
PRIORITY_STANDARD
The standard priority value if no value was set on resource. |
static java.lang.String |
PROPERTY_CHANNEL
The name of the channel property to read. |
static java.lang.String |
PROPERTY_PRIORITY
The name of the priority property to read. |
Fields inherited from class org.opencms.file.collectors.A_CmsResourceCollector |
---|
m_order, SEPARATOR_TEMPLATEFILE |
Constructor Summary | |
---|---|
CmsPriorityResourceCollector()
|
Method Summary | |
---|---|
protected java.util.List |
allInFolderPriorityDate(CmsObject cms,
java.lang.String param,
boolean tree,
boolean asc)
Returns a list of all resource in a specified folder sorted by priority, then date ascending or descending. |
protected java.util.List |
allInFolderPriorityTitle(CmsObject cms,
java.lang.String param,
boolean tree)
Returns a list of all resource in a specified folder sorted by priority descending, then Title ascending. |
protected java.util.List |
allMappedToUriPriorityDate(CmsObject cms,
java.lang.String param,
boolean asc)
Returns a list of all resource from specified folder that have been mapped to the currently requested uri, sorted by priority, then date ascending or descending. |
java.util.List |
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 |
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, 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 int PRIORITY_STANDARD
public static final java.lang.String PROPERTY_CHANNEL
public static final java.lang.String PROPERTY_PRIORITY
Constructor Detail |
---|
public CmsPriorityResourceCollector()
Method Detail |
---|
public java.util.List getCollectorNames()
I_CmsResourceCollector
I_CmsResourceCollector.getCollectorNames()
public java.lang.String getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) throws CmsException
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) throws CmsDataAccessException
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 null
CmsDataAccessException
- if the parameter attribute of the corresponding collector tag is invalidI_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 CmsException, CmsDataAccessException
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)
protected java.util.List allInFolderPriorityDate(CmsObject cms, java.lang.String param, boolean tree, boolean asc) throws CmsException
cms
- the current OpenCms user contextparam
- the folder name to usetree
- if true, look in folder and all child folders, if false, look only in given folderasc
- if true, the date sort order is ascending, otherwise descending
CmsException
- if something goes wrongprotected java.util.List allInFolderPriorityTitle(CmsObject cms, java.lang.String param, boolean tree) throws CmsException
cms
- the current OpenCms user contextparam
- the folder name to usetree
- if true, look in folder and all child folders, if false, look only in given folder
CmsException
- if something goes wrongprotected java.util.List allMappedToUriPriorityDate(CmsObject cms, java.lang.String param, boolean asc) throws CmsException
cms
- the current OpenCms user contextparam
- the folder name to useasc
- if true, the date sort order is ascending, otherwise descending
CmsException
- if something goes wrong
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |