org.opencms.file.collectors
Class 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}|{AddParam1}|{AddParam2}...", for example:
"/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.

Since:

7.0.2

Version:

$Revision: 1.4 $

Author:

Alexander Kandzior

See Also:

CmsCollectorData

Constructor Summary

protected	CmsExtendedCollectorData() Required constructor for subclasses.
	CmsExtendedCollectorData(java.lang.String data) Creates a new extended collector data set.

Method Summary

java.util.List	getAdditionalParams() Returns the List of additional parameters (String objects).
protected void	setAdditionalParams(java.util.List additionalParams) Sets the List of additional parameters (String objects).

Methods inherited from class org.opencms.file.collectors.CmsCollectorData

getCount, getFileName, getType, setCount, setFileName, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

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|p1|p2|p3|p4".

Parameters:

data - the data to parse

Method Detail

getAdditionalParams

public java.util.List getAdditionalParams()

Returns the List of additional parameters (String objects).

Returns:

the List of additional parameters (String objects)

setAdditionalParams

protected void setAdditionalParams(java.util.List additionalParams)

Sets the List of additional parameters (String objects).

Parameters:

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