Package adams.data.spreadsheet.cellfinder

Class SingleCell

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.cellfinder.AbstractCellFinder

adams.data.spreadsheet.cellfinder.AbstractRowCellFinder

adams.data.spreadsheet.cellfinder.SingleCell

All Implemented Interfaces:

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

public class SingleCell
extends AbstractRowCellFinder

Simple locator that just locates a single cell.

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 <adams.core.Index> (property: row)
    The row to locate.
    default: first
 

-column <adams.core.Index> (property: column)
    The column to locate.
    default: first
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_Column	the column.
protected Index	m_Row	the row.

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

Method Summary

Modifier and Type	Method	Description
String	columnTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Iterator<CellLocation>	doFindCells(Row row)	Performs the actual locating.
protected Iterator<CellLocation>	doFindCells(SpreadSheet sheet)	Performs the actual locating.
SpreadSheetColumnIndex	getColumn()	Returns the column to locate.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Index	getRow()	Returns the row to locate.
String	globalInfo()	Returns a string describing the object.
String	rowTipText()	Returns the tip text for this property.
void	setColumn(SpreadSheetColumnIndex value)	Sets the column to locate.
void	setRow(Index value)	Sets the row to locate.

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

check, findCells

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.data.spreadsheet.cellfinder.CellFinder

findCells

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Row

protected Index m_Row

the row.

m_Column

protected SpreadSheetColumnIndex m_Column

the column.

Constructor Detail

SingleCell

public SingleCell()

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

setRow

public void setRow(Index value)

Sets the row to locate.

Parameters:

value - the row

getRow

public Index getRow()

Returns the row to locate.

Returns:

the row

rowTipText

public String rowTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setColumn

public void setColumn(SpreadSheetColumnIndex value)

Sets the column to locate.

Parameters:

value - the column

getColumn

public SpreadSheetColumnIndex getColumn()

Returns the column to locate.

Returns:

the column

columnTipText

public String columnTipText()

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

doFindCells

protected Iterator<CellLocation> doFindCells(Row row)

Performs the actual locating.

Specified by:

doFindCells in class AbstractRowCellFinder

Parameters:

row - the row to locate the cells in

Returns:

the iterator over the locations