AbstractRowCellFinder (adams-pom 24.5.0-SNAPSHOT API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CellRange, CellTypeRange, SingleCell
```
public abstract class AbstractRowCellFinder
extends AbstractCellFinder
implements RowCellFinder
```
Ancestor for cell finders that operate on sheets or rows.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractRowCellFinder()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`check(Row row)`	Checks whether the row can be processed.
`protected abstract Iterator<CellLocation>`	`doFindCells(Row row)`	Performs the actual locating.
`Iterator<CellLocation>`	`findCells(Row row)`	Locates the cells in the row.

Methods inherited from class adams.data.spreadsheet.cellfinder.AbstractCellFinder
check, doFindCells, findCells, forCommandLine, forName, getCellFinders, getQuickInfo, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Methods inherited from interface adams.core.QuickInfoSupporter
getQuickInfo

- Constructor Detail
  - AbstractRowCellFinder
```
public AbstractRowCellFinder()
```
- Method Detail
  - check
```
protected void check(Row row)
```
    Checks whether the row can be processed.
    
    Default implementation only checks whether a spreadsheet was provided.
    
    Parameters:
    
    row - the row to check
  - doFindCells
```
protected abstract Iterator<CellLocation> doFindCells(Row row)
```
    Performs the actual locating.
    
    Parameters:
    
    row - the row to locate the cells in
    
    Returns:
    
    the iterator over the locations
  - findCells
```
public Iterator<CellLocation> findCells(Row row)
```
    Locates the cells in the row.
    
    Specified by:
    
    findCells in interface RowCellFinder
    
    Parameters:
    
    row - the row to locate the cells in
    
    Returns:
    
    the iterator over the locations