adams.data.spreadsheet.columnfinder
Class ByName

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.spreadsheet.columnfinder.AbstractColumnFinder
              adams.data.spreadsheet.columnfinder.ByName

All Implemented Interfaces:

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

public class ByName
extends AbstractColumnFinder

Returns indices of columns which names match the regular expression.

Version:

$Revision: 6066 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected BaseRegExp

m_RegExp the regular expression to match the attribute names against.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

ByName()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected int[]	doFindColumns(SpreadSheet data) Returns the columns of interest in the spreadsheet.
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	setRegExp(BaseRegExp value) Sets the regular expression to use.

Methods inherited from class adams.data.spreadsheet.columnfinder.AbstractColumnFinder

arrayToHashSet, check, compareTo, equals, filter, findColumns, forCommandLine, forName, getColumnFinders, 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_RegExp

protected BaseRegExp m_RegExp

the regular expression to match the attribute names against.

Constructor Detail

ByName

public ByName()

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

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

doFindColumns

protected int[] doFindColumns(SpreadSheet data)

Returns the columns of interest in the spreadsheet.

Specified by:

doFindColumns in class AbstractColumnFinder

Parameters:

data - the spreadsheet to inspect

Returns:

the columns of interest