Package adams.data.spreadsheet.cellfinder

Class ColumnFinderRange

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.cellfinder.AbstractCellFinder

adams.data.spreadsheet.cellfinder.ColumnFinderRange

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, CellFinder, Serializable

public class ColumnFinderRange
extends AbstractCellFinder

Uses a column finder to locate the interesting columns.

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
 

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

-column-finder <adams.data.spreadsheet.columnfinder.ColumnFinder> (property: columnFinder)
    The column finder to use for locating the columns.
    default: adams.data.spreadsheet.columnfinder.ByIndex
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnFinder	m_ColumnFinder	the column finder.
protected Range	m_Rows	the rows.

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

Method Summary

Modifier and Type	Method	Description
String	columnFinderTipText()	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.
ColumnFinder	getColumnFinder()	Returns the column finder to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Range	getRows()	Returns the rows to locate.
String	globalInfo()	Returns a string describing the object.
String	rowsTipText()	Returns the tip text for this property.
void	setColumnFinder(ColumnFinder value)	Sets the column finder to use.
void	setRows(Range value)	Sets the rows to locate.

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Rows

protected Range m_Rows

the rows.

m_ColumnFinder

protected ColumnFinder m_ColumnFinder

the column finder.

Constructor Detail

ColumnFinderRange

public ColumnFinderRange()

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

setRows

public void setRows(Range value)

Sets the rows to locate.

Parameters:

value - the rows

getRows

public Range getRows()

Returns the rows to locate.

Returns:

the rows

rowsTipText

public String rowsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setColumnFinder

public void setColumnFinder(ColumnFinder value)

Sets the column finder to use.

Parameters:

value - the finder

getColumnFinder

public ColumnFinder getColumnFinder()

Returns the column finder to use.

Returns:

the finder

columnFinderTipText

public String columnFinderTipText()

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 AbstractCellFinder

Returns:

null if no info available, otherwise short string

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