Class CmsCollectorData

  • Direct Known Subclasses:
    CmsExtendedCollectorData

    public class CmsCollectorData
    extends java.lang.Object
    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".
    The {Count} and excludeTimerange values are optional.
    Example:
    "/my/folder/|xmlcontent|5|excludeTimerange".

    Since:
    6.0.0
    See Also:
    CmsExtendedCollectorData
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PARAM_EXCLUDETIMERANGE
      The value of the optional parameter to exclude the time range.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected CmsCollectorData()
      Required constructor for subclasses.
        CmsCollectorData​(java.lang.String data)
      Creates a new extended collector data set.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getCount()
      Returns the count.
      java.lang.String getFileName()
      Returns the file name.
      int getType()
      Returns the type.
      boolean isExcludeTimerange()
      Returns the flag to exclude the time range in an offline project.
      protected void setCount​(int count)
      Sets the count.
      void setExcludeTimerange​(boolean excludeTimerange)
      Sets the flag to exclude the time range in an offline project.
      void setFileName​(java.lang.String fileName)
      Sets the fileName.
      void setType​(int type)
      Sets the type.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsCollectorData

        public CmsCollectorData​(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}|excludeTimerange", for example:
        "/my/folder/|xmlcontent|5|excludeTimerange".

        Parameters:
        data - the data to parse
      • CmsCollectorData

        protected CmsCollectorData()
        Required constructor for subclasses.

    • Method Detail

      • getCount

        public int getCount()
        Returns the count.

        Returns:
        the count
      • getFileName

        public java.lang.String getFileName()
        Returns the file name.

        Returns:
        the file name
      • getType

        public int getType()
        Returns the type.

        Returns:
        the type
      • isExcludeTimerange

        public boolean isExcludeTimerange()
        Returns the flag to exclude the time range in an offline project.

        Returns:
        the flag to exclude the time range in an offline project
      • setExcludeTimerange

        public void setExcludeTimerange​(boolean excludeTimerange)
        Sets the flag to exclude the time range in an offline project.

        Parameters:
        excludeTimerange - the flag to exclude the time range in an offline project
      • setFileName

        public void setFileName​(java.lang.String fileName)
        Sets the fileName.

        Parameters:
        fileName - the file name to set
      • setType

        public void setType​(int type)
        Sets the type.

        Parameters:
        type - the type to set
      • setCount

        protected void setCount​(int count)
        Sets the count.

        Parameters:
        count - the count