Package org.opencms.ade.publish

Class CmsCollectorPublishListHelper

java.lang.Object

org.opencms.ade.publish.CmsCollectorPublishListHelper

public class CmsCollectorPublishListHelper
extends Object

Helper class used to determine which resources from a collector list should be included in a publish list.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	OFFLINE	Boolean constant.
static final boolean	ONLINE	Boolean constant.

Constructor Summary

Constructors

Constructor	Description
CmsCollectorPublishListHelper(CmsObject cms, I_CmsContentLoadCollectorInfo collectorInfo, int collectorLimit)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected List<CmsResource>	computeCollectorResults(boolean online)	Computes the collector results.
CmsObject	getCmsObject(boolean online)	Initializes a CmsObject.
I_CmsResourceCollector	getCollector()	Gets the collector to use.
Set<CmsResource>	getPublishListFiles()	Gets the list to add to the publish list for the collector list.

Methods inherited from class java.lang.Object

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

Field Details

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 Details

CmsCollectorPublishListHelper

public CmsCollectorPublishListHelper(CmsObject cms,
 I_CmsContentLoadCollectorInfo collectorInfo,
 int collectorLimit)

Creates a new instance.

Parameters:

cms - the CMS context to use

collectorInfo - the collector information

collectorLimit - the number of resources which should be fetched via the collector

Method Details

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 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 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