Package adams.flow.transformer.arraysubsetgeneration

Class Percentage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.arraysubsetgeneration.AbstractArraySubsetGenerator

adams.flow.transformer.arraysubsetgeneration.Percentage

All Implemented Interfaces:

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

public class Percentage
extends AbstractArraySubsetGenerator

Uses the specified percentage to determine which nth elements to be used in the new array.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Offset	the offset.
protected double	m_Percentage	the percentage to pick (0-100).

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Object	doGenerateSubset(Object array, MessageCollection errors)	Generates the subset.
int	getOffset()	Returns the offset.
double	getPercentage()	Returns the percentage to pick.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	offsetTipText()	Returns the tip text for this property.
String	percentageTipText()	Returns the tip text for this property.
void	setOffset(int value)	Sets the offset.
void	setPercentage(double value)	Sets the percentage to pick.

Methods inherited from class adams.flow.transformer.arraysubsetgeneration.AbstractArraySubsetGenerator

check, generateSubset, newArray

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_Offset

protected int m_Offset

the offset.

m_Percentage

protected double m_Percentage

the percentage to pick (0-100).

Constructor Detail

Percentage

public Percentage()

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

setOffset

public void setOffset(int value)

Sets the offset.

Parameters:

value - the offset

getOffset

public int getOffset()

Returns the offset.

Returns:

the offset

offsetTipText

public String offsetTipText()

Returns the tip text for this property.

Returns:

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

setPercentage

public void setPercentage(double value)

Sets the percentage to pick.

Parameters:

value - the percentage to pick (100 = same as input)

getPercentage

public double getPercentage()

Returns the percentage to pick.

Returns:

the percentage to pick (100 = same as input)

percentageTipText

public String percentageTipText()

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 actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractArraySubsetGenerator

Returns:

null if no info available, otherwise short string

doGenerateSubset

protected Object doGenerateSubset(Object array,
                                  MessageCollection errors)

Generates the subset.

Specified by:

doGenerateSubset in class AbstractArraySubsetGenerator

Parameters:

array - the array to generate the subset from

errors - for collecting errors

Returns:

null in case of an error