Package adams.data.spreadsheet.rowfinder

Class ByNumericValue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowfinder.AbstractRowFinder

adams.data.spreadsheet.rowfinder.ByNumericValue

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<RowFinder>, SizeOfHandler, RowFinder, Serializable

public class ByNumericValue
extends AbstractRowFinder

Returns indices of rows which numeric value match the min/max.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_AttributeIndex	the attribute index to work on.
protected double	m_Maximum	the maximum value.
protected boolean	m_MaximumIncluded	whether the maximum value is included.
protected double	m_Minimum	the minimum value.
protected boolean	m_MinimumIncluded	whether the minimum value is included.
static String	NAN	the placeholder for NaN.

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

Method Summary

Modifier and Type	Method	Description
String	attributeIndexTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindRows(SpreadSheet data)	Returns the rows of interest in the spreadsheet.
SpreadSheetColumnIndex	getAttributeIndex()	Returns the index of the column to perform the matching on.
double	getMaximum()	Returns the maximum.
boolean	getMaximumIncluded()	Returns whether the maximum is included.
double	getMinimum()	Returns the minimum.
boolean	getMinimumIncluded()	Returns whether the minimum is included.
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	maximumIncludedTipText()	Returns the tip text for this property.
String	maximumTipText()	Returns the tip text for this property.
String	minimumIncludedTipText()	Returns the tip text for this property.
String	minimumTipText()	Returns the tip text for this property.
void	setAttributeIndex(SpreadSheetColumnIndex value)	Sets the index of the column to perform the matching on.
void	setMaximum(double value)	Sets the maximum.
void	setMaximumIncluded(boolean value)	Sets whether to exclude the maximum.
void	setMinimum(double value)	Sets the minimum.
void	setMinimumIncluded(boolean value)	Sets whether to exclude the minimum.

Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractRowFinder

arrayToHashSet, check, compareTo, equals, filter, findRows, forCommandLine, forName, getRowFinders, shallowCopy, shallowCopy

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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

NAN

public static final String NAN

the placeholder for NaN.

See Also:

Constant Field Values

m_AttributeIndex

protected SpreadSheetColumnIndex m_AttributeIndex

the attribute index to work on.

m_Minimum

protected double m_Minimum

the minimum value.

m_MinimumIncluded

protected boolean m_MinimumIncluded

whether the minimum value is included.

m_Maximum

protected double m_Maximum

the maximum value.

m_MaximumIncluded

protected boolean m_MaximumIncluded

whether the maximum value is included.

Constructor Detail

ByNumericValue

public ByNumericValue()

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

setAttributeIndex

public void setAttributeIndex(SpreadSheetColumnIndex value)

Sets the index of the column to perform the matching on.

Parameters:

value - the index

getAttributeIndex

public SpreadSheetColumnIndex getAttributeIndex()

Returns the index of the column to perform the matching on.

Returns:

the index

attributeIndexTipText

public String attributeIndexTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMinimum

public void setMinimum(double value)

Sets the minimum.

Parameters:

value - the minimum

getMinimum

public double 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

setMinimumIncluded

public void setMinimumIncluded(boolean value)

Sets whether to exclude the minimum.

Parameters:

value - true to exclude minimum

getMinimumIncluded

public boolean getMinimumIncluded()

Returns whether the minimum is included.

Returns:

true if minimum included

minimumIncludedTipText

public String minimumIncludedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMaximum

public void setMaximum(double value)

Sets the maximum.

Parameters:

value - the maximum

getMaximum

public double 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

setMaximumIncluded

public void setMaximumIncluded(boolean value)

Sets whether to exclude the maximum.

Parameters:

value - true to exclude maximum

getMaximumIncluded

public boolean getMaximumIncluded()

Returns whether the maximum is included.

Returns:

true if maximum included

maximumIncludedTipText

public String maximumIncludedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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 AbstractRowFinder

Returns:

null if no info available, otherwise short string

doFindRows

protected int[] doFindRows(SpreadSheet data)

Returns the rows of interest in the spreadsheet.

Specified by:

doFindRows in class AbstractRowFinder

Parameters:

data - the spreadsheet to inspect

Returns:

the rows of interest