adams.data.spreadsheet.rowfinder
Class ByValue

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.spreadsheet.rowfinder.AbstractRowFinder
              adams.data.spreadsheet.rowfinder.ByValue

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<RowFinder>, SizeOfHandler, RowFinder, Serializable

public class ByValue
extends AbstractRowFinder

Returns indices of rows which label match the regular expression.

Version:

$Revision: 6946 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetColumnIndex	m_AttributeIndex the attribute index to work on.
protected BaseRegExp	m_RegExp the regular expression to match the labels against.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

ByValue()

Method Summary

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.
BaseRegExp	getRegExp() Returns the regular expression in use.
String	globalInfo() Returns a string describing the object.
String	regExpTipText() Returns the tip text for this property.
void	setAttributeIndex(SpreadSheetColumnIndex value) Sets the index of the column to perform the matching on.
void	setRegExp(BaseRegExp value) Sets the regular expression to use.

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, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_AttributeIndex

protected SpreadSheetColumnIndex m_AttributeIndex

the attribute index to work on.

m_RegExp

protected BaseRegExp m_RegExp

the regular expression to match the labels against.

Constructor Detail

ByValue

public ByValue()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to use.

Parameters:

value - the regular expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression in use.

Returns:

the regular expression

regExpTipText

public String regExpTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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