Package org.opencms.ade.publish
Class CmsCollectorPublishListHelper
- java.lang.Object
-
- org.opencms.ade.publish.CmsCollectorPublishListHelper
-
public class CmsCollectorPublishListHelper extends java.lang.Object
Helper class used to determine which resources from a collector list should be included in a publish list.
-
-
Constructor Summary
Constructors Constructor Description CmsCollectorPublishListHelper(CmsObject cms, I_CmsContentLoadCollectorInfo collectorInfo, int collectorLimit)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.List<CmsResource>
computeCollectorResults(boolean online)
Computes the collector results.CmsObject
getCmsObject(boolean online)
Initializes a CmsObject.I_CmsResourceCollector
getCollector()
Gets the collector to use.java.util.Set<CmsResource>
getPublishListFiles()
Gets the list to add to the publish list for the collector list.
-
-
-
Field Detail
-
OFFLINE
public static final boolean OFFLINE
Boolean constant.- See Also:
- Constant Field Values
-
ONLINE
public static final boolean ONLINE
Boolean constant.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsCollectorPublishListHelper
public CmsCollectorPublishListHelper(CmsObject cms, I_CmsContentLoadCollectorInfo collectorInfo, int collectorLimit)
Creates a new instance.- Parameters:
cms
- the CMS context to usecollectorInfo
- the collector informationcollectorLimit
- the number of resources which should be fetched via the collector
-
-
Method Detail
-
getCmsObject
public CmsObject getCmsObject(boolean online) throws CmsException
Initializes a CmsObject.- Parameters:
online
- true if a CmsObject for the Online project should be returned- Returns:
- the initialized CmsObject
- Throws:
CmsException
- if something goes wrong
-
getCollector
public I_CmsResourceCollector getCollector()
Gets the collector to use.- Returns:
- the collector to use
-
getPublishListFiles
public java.util.Set<CmsResource> getPublishListFiles() throws CmsException
Gets the list to add to the publish list for the collector list.- Returns:
- the resources to add to the publish list
- Throws:
CmsException
- if something goes wrong
-
computeCollectorResults
protected java.util.List<CmsResource> computeCollectorResults(boolean online) throws CmsException
Computes the collector results.- Parameters:
online
- true if the collector results for the Online project should be returned- Returns:
- the collector results
- Throws:
CmsException
- if something goes wrong
-
-