Package adams.data.outlier
Class TimeseriesTimestampCheck
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.outlier.AbstractOutlierDetector<Timeseries>
-
- adams.data.outlier.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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TimeseriesTimestampCheck.TimestampCondition
Determines what condition the selected timestamp must satisfy.-
Nested classes/interfaces inherited from class adams.data.outlier.AbstractOutlierDetector
AbstractOutlierDetector.DetectorJob<T extends DataContainer>
-
-
Field Summary
Fields Modifier and Type Field Description protected TimeseriesTimestampCheck.TimestampCondition
m_Condition
the condition that the timestamp must meet.protected Index
m_Index
the index of the timestamp to check.protected BaseDateTime
m_Timestamp
the provided timestamp.-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description TimeseriesTimestampCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkData(Timeseries data)
The default implementation only checks whether there is any data set.String
conditionTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.TimeseriesTimestampCheck.TimestampCondition
getCondition()
Returns the condition that the selected timestamp must meet.Index
getIndex()
Returns the index of the timestamp to inspect.BaseDateTime
getTimestamp()
Returns the timestamp to use in the check.String
globalInfo()
Returns a string describing the object.String
indexTipText()
Returns the tip text for this property.protected List<String>
processData(Timeseries data)
Performs the actual detection.void
setCondition(TimeseriesTimestampCheck.TimestampCondition value)
Sets the condition that the selected timestamp must meet.void
setIndex(Index value)
Sets the index of the timestamp to inspect.void
setTimestamp(BaseDateTime value)
Sets the timestamp to use in the check.String
timestampTipText()
Returns the tip text for this property.-
Methods inherited from class adams.data.outlier.AbstractOutlierDetector
cleanUp, compareTo, destroy, detect, equals, forCommandLine, forName, getOutlierDetectors, getQuickInfo, reset, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine
-
-
-
-
Field Detail
-
m_Index
protected Index m_Index
the index of the timestamp to check.
-
m_Condition
protected TimeseriesTimestampCheck.TimestampCondition m_Condition
the condition that the timestamp must meet.
-
m_Timestamp
protected BaseDateTime m_Timestamp
the provided timestamp.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
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.
-
setCondition
public void setCondition(TimeseriesTimestampCheck.TimestampCondition value)
Sets the condition that the selected timestamp must meet.- Parameters:
value
- the condition
-
getCondition
public TimeseriesTimestampCheck.TimestampCondition getCondition()
Returns the condition that the selected timestamp must meet.- Returns:
- the condition
-
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.
-
checkData
protected void checkData(Timeseries data)
The default implementation only checks whether there is any data set.- Overrides:
checkData
in classAbstractOutlierDetector<Timeseries>
- Parameters:
data
- the data to process
-
processData
protected List<String> processData(Timeseries data)
Performs the actual detection.- Specified by:
processData
in classAbstractOutlierDetector<Timeseries>
- Parameters:
data
- the data to process- Returns:
- the detections
-
-