org.opencms.file.collectors

类 CmsExtendedCollectorData

java.lang.Object

org.opencms.file.collectors.CmsCollectorData

org.opencms.file.collectors.CmsExtendedCollectorData

public class CmsExtendedCollectorData
extends CmsCollectorData

Extended data structure for the collector, parsed from the collector parameters.

The input data String must have the following format:
"{VFS URI}|{Resource type}|{Count}|excludeTimerange|{AddParam1}|{AddParam2}...", for example:
"/my/folder/|xmlcontent|5|excludeTimerange|p1|p2|p3|p4" or "/my/folder/|xmlcontent|5|p1|p2|p3|p4".

This extends the basic CmsCollectorData by allowing to append additional parameters to the input String. The parameters can then be obtained by the collector using getAdditionalParams(). It will depend on the collector implementation how these additional parameters are used.

从以下版本开始:

7.0.2

另请参阅:

CmsCollectorData

字段概要

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

PARAM_EXCLUDETIMERANGE

构造器概要

构造器

限定符	构造器和说明
protected	CmsExtendedCollectorData() Required constructor for subclasses.
	CmsExtendedCollectorData(java.lang.String data) Creates a new extended collector data set.

方法概要

方法

限定符和类型	方法和说明
java.util.List<java.lang.String>	getAdditionalParams() Returns the List of additional parameters (String objects).
protected void	setAdditionalParams(java.util.List<java.lang.String> additionalParams) Sets the List of additional parameters (String objects).

从类继承的方法 org.opencms.file.collectors.CmsCollectorData

getCount, getFileName, getType, isExcludeTimerange, setCount, setExcludeTimerange, setFileName, setType

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsExtendedCollectorData

protected CmsExtendedCollectorData()

Required constructor for subclasses.

CmsExtendedCollectorData

public CmsExtendedCollectorData(java.lang.String data)

Creates a new extended collector data set.

The input data String must have the following format:
"{VFS URI}|{Resource type}|{Count}|{AddParam1}|{AddParam2}...", for example:
"/my/folder/|xmlcontent|5|excludeTimerange|p1|p2|p3|p4" or "/my/folder/|xmlcontent|5|p1|p2|p3|p4".

参数:

data - the data to parse

方法详细资料

getAdditionalParams

public java.util.List<java.lang.String> getAdditionalParams()

Returns the List of additional parameters (String objects).

返回:

the List of additional parameters (String objects)

setAdditionalParams

protected void setAdditionalParams(java.util.List<java.lang.String> additionalParams)

Sets the List of additional parameters (String objects).

参数:

additionalParams - the List of additional parameters (String objects) to set