adams.data.spreadsheet.cellfinder
Class RowFinderRange

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.spreadsheet.cellfinder.AbstractCellFinder
              adams.data.spreadsheet.cellfinder.RowFinderRange

All Implemented Interfaces:

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

public class RowFinderRange
extends AbstractCellFinder

Uses a row finder to locate the interesting rows.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-row-finder <adams.data.spreadsheet.rowfinder.RowFinder> (property: rowFinder)
    The row finder to use for locating the rows.
    default: adams.data.spreadsheet.rowfinder.ByIndex
 

-columns <adams.core.Range> (property: columns)
    The columns to locate.
    default: first-last
 

Version:

$Revision: 6866 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetColumnRange	m_Columns the columns.
protected RowFinder	m_RowFinder the row finder.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

RowFinderRange()

Method Summary

String	columnsTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected Iterator<CellLocation>	doFindCells(SpreadSheet sheet) Performs the actual locating.
SpreadSheetColumnRange	getColumns() Returns the columns to locate.
RowFinder	getRowFinder() Returns the row finder to use for locating the rows.
String	globalInfo() Returns a string describing the object.
String	rowFinderTipText() Returns the tip text for this property.
void	setColumns(SpreadSheetColumnRange value) Sets the columns to locate.
void	setRowFinder(RowFinder value) Sets the row finder to use for locating the rows.

Methods inherited from class adams.data.spreadsheet.cellfinder.AbstractCellFinder

check, findCells, forCommandLine, forName, getCellFinders, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_RowFinder

protected RowFinder m_RowFinder

the row finder.

m_Columns

protected SpreadSheetColumnRange m_Columns

the columns.

Constructor Detail

RowFinderRange

public RowFinderRange()

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

setRowFinder

public void setRowFinder(RowFinder value)

Sets the row finder to use for locating the rows.

Parameters:

value - the finder

getRowFinder

public RowFinder getRowFinder()

Returns the row finder to use for locating the rows.

Returns:

the finder

rowFinderTipText

public String rowFinderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setColumns

public void setColumns(SpreadSheetColumnRange value)

Sets the columns to locate.

Parameters:

value - the columns

getColumns

public SpreadSheetColumnRange getColumns()

Returns the columns to locate.

Returns:

the columns

columnsTipText

public String columnsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

doFindCells

protected Iterator<CellLocation> doFindCells(SpreadSheet sheet)

Performs the actual locating.

Specified by:

doFindCells in class AbstractCellFinder

Parameters:

sheet - the sheet to locate the cells in

Returns:

the iterator over the locations