Package adams.flow.transformer.timeseriessplit

Class ReportDate

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, TechnicalInformationHandler, Serializable
    public class ReportDate
extends AbstractSplitOnDate
implements TechnicalInformationHandler
    Splits the timeseries using a field from its report.
    Accepted date formats:
    yyyy-MM-dd HH:mm:ss
    yyyy-MM-dd HH:mm:ss.S
    yyyy-MM-dd 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -segments <BOTH|BEFORE|AFTER> (property: segments)
    The segments to return.
    default: BOTH
 
    -include-split-date <boolean> (property: includeSplitDate)
    If enabled, the split date is included in the segments.
    default: false
 
    -field <adams.data.report.Field> (property: field)
    The report field to obtain the split date from.
    default: somedate[S]
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Field

        protected Field m_Field
        the field in the report to split on.

      • m_CustomFormat

        protected String m_CustomFormat
        the custom format to use.

    • Constructor Detail

      • ReportDate

        public ReportDate()

    • Method Detail

      • getTechnicalInformation

        public TechnicalInformation getTechnicalInformation()
        Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
        Specified by:
        getTechnicalInformation in interface TechnicalInformationHandler
        Returns:
        the technical information about this class

      • setField

        public void setField​(Field value)
        Sets the report field to obtain the split date from.
        Parameters:
        value - the report field

      • getField

        public Field getField()
        Returns the report field to obtain the split date from.
        Returns:
        the report field

      • fieldTipText

        public String fieldTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCustomFormat

        public void setCustomFormat​(String value)
        Sets the custom date format to use for parsing. Ignored if empty.
        Parameters:
        value - the custom format

      • getCustomFormat

        public String getCustomFormat()
        Returns the custom date format to use for parsing. Ignored if empty.
        Returns:
        the custom format

      • customFormatTipText

        public String customFormatTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • check

        protected void check​(Timeseries series)
        Performs checks on the timeseries that is to be split.

        Ensures that report and field are present.
        Overrides:
        check in class AbstractTimeseriesSplitter
        Parameters:
        series - the timeseries to split