Package adams.flow.transformer.arraysubsetgeneration

Class AbstractArraySubsetGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.arraysubsetgeneration.AbstractArraySubsetGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

EveryNth, Percentage, RangeSubset, SimplePercentage

public abstract class AbstractArraySubsetGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for schemes that generate array subsets.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(Object array)	For checking the input data.
protected abstract Object	doGenerateSubset(Object array, MessageCollection errors)	Generates the subset.
Object	generateSubset(Object array, MessageCollection errors)	Generates the subset.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
protected Object	newArray(Object array, int length)	Returns a new array instance of the specified length.

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

AbstractArraySubsetGenerator

public AbstractArraySubsetGenerator()

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 String check(Object array)

For checking the input data.

Parameters:

array - the array to check

Returns:

null if checks passed, otherwise error message

newArray

protected Object newArray(Object array,
                          int length)

Returns a new array instance of the specified length.

Parameters:

array - the old array

length - the length of the new array

Returns:

the new array

doGenerateSubset

protected abstract Object doGenerateSubset(Object array,
                                           MessageCollection errors)

Generates the subset.

Parameters:

array - the array to generate the subset from

errors - for collecting errors

Returns:

null in case of an error

generateSubset

public Object generateSubset(Object array,
                             MessageCollection errors)

Generates the subset.

Parameters:

array - the array to generate the subset from

errors - for collecting errors

Returns:

null in case of an error