Package adams.flow.transformer.timeseriessplit

Class FixedDate

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

adams.flow.transformer.timeseriessplit.AbstractSplitOnDate

adams.flow.transformer.timeseriessplit.FixedDate

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class FixedDate
extends AbstractSplitOnDate

Splits the timeseries using the specified date.

-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
 

-date <adams.core.base.BaseDateTime> (property: date)
    The split date to use.
    default: NOW
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.transformer.timeseriessplit.AbstractSplitOnDate

AbstractSplitOnDate.Segments

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseDateTime	m_Date	the date to split on.

Fields inherited from class adams.flow.transformer.timeseriessplit.AbstractSplitOnDate

m_IncludeSplitDate, m_Segments

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
FixedDate()

Method Summary

Modifier and Type	Method	Description
String	dateTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Timeseries[]	doSplit(Timeseries series)	Performs the actual split.
BaseDateTime	getDate()	Returns the split date.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setDate(BaseDateTime value)	Sets the split date.

Methods inherited from class adams.flow.transformer.timeseriessplit.AbstractSplitOnDate

doSplit, getIncludeSplitDate, getSegments, includeSplitDateTipText, segmentsTipText, setIncludeSplitDate, setSegments

Methods inherited from class adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

check, postProcess, split

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Date

protected BaseDateTime m_Date

the date to split on.

Constructor Detail

FixedDate

public FixedDate()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

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 interface OptionHandler

Overrides:

defineOptions in class AbstractSplitOnDate

setDate

public void setDate(BaseDateTime value)

Sets the split date.

Parameters:

value - the date

getDate

public BaseDateTime getDate()

Returns the split date.

Returns:

the date

dateTipText

public String dateTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractSplitOnDate

Returns:

null if no info available, otherwise short string

doSplit

protected Timeseries[] doSplit(Timeseries series)

Performs the actual split.

Specified by:

doSplit in class AbstractTimeseriesSplitter

Parameters:

series - the timeseries to split

Returns:

the generated sub-timeseries