Package adams.flow.transformer.negativeregions

Class AbstractMetaNegativeRegionsGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

adams.flow.transformer.negativeregions.AbstractMetaNegativeRegionsGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

LargestRegions, MaxDimensions, MinDimensions

public abstract class AbstractMetaNegativeRegionsGenerator
extends AbstractNegativeRegionsGenerator

Ancestor for meta-algorithms.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractNegativeRegionsGenerator	m_ActualAlgorithm	the actual algorithm in use.
protected AbstractNegativeRegionsGenerator	m_Algorithm	the base generator to use.

Fields inherited from class adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

m_Stopped

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

Method Summary

Modifier and Type	Method	Description
String	algorithmTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected AbstractNegativeRegionsGenerator	getActualAlgorithm()	Returns the actual algorithm to use.
AbstractNegativeRegionsGenerator	getAlgorithm()	Returns the algorithm in use.
AbstractNegativeRegionsGenerator	getDefaultAlgorithm()	Returns the default algorithm.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
protected void	reset()	Resets the scheme.
void	setAlgorithm(AbstractNegativeRegionsGenerator value)	Sets the algorithm to use.

Methods inherited from class adams.flow.transformer.negativeregions.AbstractNegativeRegionsGenerator

check, doGenerateRegions, generateRegions, isStopped, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Algorithm

protected AbstractNegativeRegionsGenerator m_Algorithm

the base generator to use.

m_ActualAlgorithm

protected AbstractNegativeRegionsGenerator m_ActualAlgorithm

the actual algorithm in use.

Constructor Detail

AbstractMetaNegativeRegionsGenerator

public AbstractMetaNegativeRegionsGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

getDefaultAlgorithm

public AbstractNegativeRegionsGenerator getDefaultAlgorithm()

Returns the default algorithm.

Returns:

the default

setAlgorithm

public void setAlgorithm(AbstractNegativeRegionsGenerator value)

Sets the algorithm to use.

Parameters:

value - the algorithm

getAlgorithm

public AbstractNegativeRegionsGenerator getAlgorithm()

Returns the algorithm in use.

Returns:

the algorithm

algorithmTipText

public String algorithmTipText()

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 AbstractNegativeRegionsGenerator

Returns:

null if no info available, otherwise short string

getActualAlgorithm

protected AbstractNegativeRegionsGenerator getActualAlgorithm()

Returns the actual algorithm to use.

Returns:

the algorithm to use