Package adams.flow.transformer.timeseriessplit

Class AbstractTimeseriesSplitter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSplitOnDate, FixedLengthSegments, FixedNumSegments, PassThrough

public abstract class AbstractTimeseriesSplitter
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for timeseries splitters.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected void	check(Timeseries series)	Performs checks on the timeseries that is to be split.
protected abstract Timeseries[]	doSplit(Timeseries series)	Performs the actual split.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
protected Timeseries[]	postProcess(Timeseries[] segments)	Post-processes the segments.
Timeseries[]	split(Timeseries series)	Splits the timeseries.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractTimeseriesSplitter

public AbstractTimeseriesSplitter()

Method Detail

getQuickInfo

public String getQuickInfo()

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

Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected void check(Timeseries series)

Performs checks on the timeseries that is to be split.

Default implementation only checks whether data has been provided.

Parameters:

series - the timeseries to split

doSplit

protected abstract Timeseries[] doSplit(Timeseries series)

Performs the actual split.

Parameters:

series - the timeseries to split

Returns:

the generated sub-timeseries

postProcess

protected Timeseries[] postProcess(Timeseries[] segments)

Post-processes the segments.

Parameters:

segments - the segments to process

Returns:

the processed segments

split

public Timeseries[] split(Timeseries series)

Splits the timeseries.

Parameters:

series - the timeseries to split

Returns:

the generated sub-timeseries