Package adams.data.spreadsheet.rowfinder

Class ClosestNumericValue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowfinder.AbstractRowFinder

adams.data.spreadsheet.rowfinder.ClosestNumericValue

All Implemented Interfaces:

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

public class ClosestNumericValue
extends AbstractRowFinder

Returns the index of the row that comes closest to the provided numeric value.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClosestNumericValue.SearchDirection	Determines how the search is performed.

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_AttributeIndex	the attribute index to work on.
protected ClosestNumericValue.SearchDirection	m_SearchDirection	the search direction.
protected double	m_Value	the value to get to as close as possible.

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

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.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
ClosestNumericValue.SearchDirection	getSearchDirection()	Returns the search direction to use.
double	getValue()	Returns the value to get closest to.
String	globalInfo()	Returns a string describing the object.
String	searchDirectionTipText()	Returns the tip text for this property.
void	setAttributeIndex(SpreadSheetColumnIndex value)	Sets the index of the column to perform the matching on.
void	setSearchDirection(ClosestNumericValue.SearchDirection value)	Sets the search direction to use.
void	setValue(double value)	Sets the value to get closest to.
String	valueTipText()	Returns the tip text for this property.

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

m_AttributeIndex

protected SpreadSheetColumnIndex m_AttributeIndex

the attribute index to work on.

m_Value

protected double m_Value

the value to get to as close as possible.

m_SearchDirection

protected ClosestNumericValue.SearchDirection m_SearchDirection

the search direction.

Constructor Detail

ClosestNumericValue

public ClosestNumericValue()

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

setValue

public void setValue(double value)

Sets the value to get closest to.

Parameters:

value - the value

getValue

public double getValue()

Returns the value to get closest to.

Returns:

the value

valueTipText

public String valueTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setSearchDirection

public void setSearchDirection(ClosestNumericValue.SearchDirection value)

Sets the search direction to use.

Parameters:

value - the direction

getSearchDirection

public ClosestNumericValue.SearchDirection getSearchDirection()

Returns the search direction to use.

Returns:

the direction

searchDirectionTipText

public String searchDirectionTipText()

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