Package adams.flow.transformer.timeseriessplit

Class FixedNumSegments

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.timeseriessplit.AbstractTimeseriesSplitter

adams.flow.transformer.timeseriessplit.FixedNumSegments

All Implemented Interfaces:

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

public class FixedNumSegments
extends AbstractTimeseriesSplitter

Splits the timeseries into a fixed number of same-sized segements.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-num-segments <int> (property: numSegments)
    The number of segments to generate.
    default: 2
    minimum: 1
    maximum: 0
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumSegments	the number of 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
FixedNumSegments()

Method Summary

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

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_NumSegments

protected int m_NumSegments

the number of segments.

Constructor Detail

FixedNumSegments

public FixedNumSegments()

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 AbstractOptionHandler

setNumSegments

public void setNumSegments(int value)

Sets the number of segments.

Parameters:

value - the number of segments

getNumSegments

public int getNumSegments()

Returns the number segments.

Returns:

the number of segments

numSegmentsTipText

public String numSegmentsTipText()

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 AbstractTimeseriesSplitter

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