Class TimeseriesTimestampCheck

  • All Implemented Interfaces:
    CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<OutlierDetector>, SizeOfHandler, OutlierDetector<Timeseries>, Serializable, Comparable

    public class TimeseriesTimestampCheck
    extends AbstractOutlierDetector<Timeseries>
    Checks whether the timestamp with the specified index meets the condition (eg before or after the supplied timestamp).

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -index <adams.core.Index> (property: index)
        The index of the timestamp to use for the check.
        default: first
        example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
     
    -condition <BEFORE|AFTER> (property: condition)
        The condition that the selected timestamp must meet.
        default: AFTER
     
    -timestamp <adams.core.base.BaseDateTime> (property: timestamp)
        The timestamp to use in the check.
        default: -INF
     
    Version:
    $Revision: 995 $
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Constructor Detail

      • TimeseriesTimestampCheck

        public TimeseriesTimestampCheck()
    • Method Detail

      • setIndex

        public void setIndex​(Index value)
        Sets the index of the timestamp to inspect.
        Parameters:
        value - the index
      • getIndex

        public Index getIndex()
        Returns the index of the timestamp to inspect.
        Returns:
        the index
      • indexTipText

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

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

        public void setTimestamp​(BaseDateTime value)
        Sets the timestamp to use in the check.
        Parameters:
        value - the timestamp
      • getTimestamp

        public BaseDateTime getTimestamp()
        Returns the timestamp to use in the check.
        Returns:
        the timestamp
      • timestampTipText

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