Package adams.core.discovery.genetic

Class AbstractGeneticIntegerDiscoveryHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.discovery.AbstractDiscoveryHandler

adams.core.discovery.genetic.AbstractGeneticDiscoveryHandler

adams.core.discovery.genetic.AbstractGeneticIntegerDiscoveryHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractDiscoveryHandler>, SizeOfHandler, Serializable

Direct Known Subclasses:

GenericInteger, PLSFilterNumComponents, SavitzkyGolay2NumPoints

public abstract class AbstractGeneticIntegerDiscoveryHandler
extends AbstractGeneticDiscoveryHandler

Ancestor for genetic discovery handlers that handle integer properties.

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_List	the list of values.
protected int	m_Maximum	the maximum.
protected int	m_Minimum	the minimum.
protected NumericValueType	m_Type	the type of values to use.

Fields inherited from class adams.core.discovery.AbstractDiscoveryHandler

m_Containers, m_InvertMatching, m_RegExp

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

Method Summary

Modifier and Type	Method	Description
protected int	calcNumBits()	Calculates the number of bits.
void	defineOptions()	Adds options to the internal list of options.
protected String	doPack(PropertyPath.PropertyContainer cont)	Returns the packed bits for the genetic algorithm.
protected void	doUnpack(PropertyPath.PropertyContainer cont, String bits)	Unpacks and applies the bits from the genetic algorithm.
protected abstract String	getDefaultList()	Returns the default list.
protected abstract int	getDefaultMaximum()	Returns the default maximum.
protected abstract int	getDefaultMinimum()	Returns the default minimum.
protected NumericValueType	getDefaultType()	Returns the default type.
String	getList()	Returns the list of values to use (blank-separated).
int	getMaximum()	Returns the maximum.
int	getMinimum()	Returns the minimum.
int	getNumBits()	Returns the number of required bits.
NumericValueType	getType()	Returns the type.
protected abstract int	getValue(PropertyPath.PropertyContainer cont)	Returns the integer value from the property container.
String	listTipText()	Returns the tip text for this property.
String	maximumTipText()	Returns the tip text for this property.
String	minimumTipText()	Returns the tip text for this property.
void	setList(String value)	Sets the list of values to use (blank-separated).
void	setMaximum(int value)	Sets the maximum.
void	setMinimum(int value)	Sets the minimum.
void	setType(NumericValueType value)	Sets the type.
protected abstract void	setValue(PropertyPath.PropertyContainer cont, int value)	Sets the integer value in the property container.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.discovery.genetic.AbstractGeneticDiscoveryHandler

pack, performInitialization, requiresInitialization, unpack

Methods inherited from class adams.core.discovery.AbstractDiscoveryHandler

addContainer, getContainers, getInvertMatching, getRegExp, handles, handles, invertMatchingTipText, regExpTipText, reset, setInvertMatching, setRegExp, shallowCopy, shallowCopy, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine

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_Type

protected NumericValueType m_Type

the type of values to use.

m_Minimum

protected int m_Minimum

the minimum.

m_Maximum

protected int m_Maximum

the maximum.

m_List

protected int[] m_List

the list of values.

Constructor Detail

AbstractGeneticIntegerDiscoveryHandler

public AbstractGeneticIntegerDiscoveryHandler()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractDiscoveryHandler

getDefaultType

protected NumericValueType getDefaultType()

Returns the default type.

Returns:

the default

setType

public void setType(NumericValueType value)

Sets the type.

Parameters:

value - the type

getType

public NumericValueType getType()

Returns the type.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

getDefaultMinimum

protected abstract int getDefaultMinimum()

Returns the default minimum.

Returns:

the default

setMinimum

public void setMinimum(int value)

Sets the minimum.

Parameters:

value - the minimum

getMinimum

public int getMinimum()

Returns the minimum.

Returns:

the minimum

minimumTipText

public String minimumTipText()

Returns the tip text for this property.

Returns:

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

getDefaultMaximum

protected abstract int getDefaultMaximum()

Returns the default maximum.

Returns:

the default

setMaximum

public void setMaximum(int value)

Sets the maximum.

Parameters:

value - the maximum

getMaximum

public int getMaximum()

Returns the maximum.

Returns:

the maximum

maximumTipText

public String maximumTipText()

Returns the tip text for this property.

Returns:

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

getDefaultList

protected abstract String getDefaultList()

Returns the default list.

Returns:

the default

setList

public void setList(String value)

Sets the list of values to use (blank-separated).

Parameters:

value - the list

getList

public String getList()

Returns the list of values to use (blank-separated).

Returns:

the list

listTipText

public String listTipText()

Returns the tip text for this property.

Returns:

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

calcNumBits

protected int calcNumBits()

Calculates the number of bits.

Returns:

the number of bits

getNumBits

public int getNumBits()

Returns the number of required bits.

Specified by:

getNumBits in class AbstractGeneticDiscoveryHandler

Returns:

the number of bits

getValue

protected abstract int getValue(PropertyPath.PropertyContainer cont)

Returns the integer value from the property container.

Parameters:

cont - the container

Returns:

the value

doPack

protected String doPack(PropertyPath.PropertyContainer cont)

Returns the packed bits for the genetic algorithm.

Specified by:

doPack in class AbstractGeneticDiscoveryHandler

Parameters:

cont - the container to obtain the value from to turn into a string

Returns:

the bits

setValue

protected abstract void setValue(PropertyPath.PropertyContainer cont,
                                 int value)

Sets the integer value in the property container.

Parameters:

cont - the container

value - the value to set

doUnpack

protected void doUnpack(PropertyPath.PropertyContainer cont,
                        String bits)

Unpacks and applies the bits from the genetic algorithm.

Specified by:

doUnpack in class AbstractGeneticDiscoveryHandler

Parameters:

cont - the container to set the value for created from the string

bits - the bits to use