adams.data.spreadsheet.rowfinder
Class ByIndex

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.data.spreadsheet.rowfinder.AbstractRowFinder
              extended by adams.data.spreadsheet.rowfinder.ByIndex
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<RowFinder>, SizeOfHandler, RowFinder, Serializable

public class ByIndex
extends AbstractRowFinder

Returns indices of rows that fall in the defined range.

Version:
$Revision: 6155 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

Field Summary
protected  Range m_Rows
          the range of rows to select.
 
Fields inherited from class adams.core.option.AbstractOptionHandler
m_DebugLevel, m_OptionManager
 
Constructor Summary
ByIndex()
           
 
Method Summary
 void defineOptions()
          Adds options to the internal list of options.
protected  int[] doFindRows(SpreadSheet data)
          Returns the rows of interest in the spreadsheet.
 Range getRows()
          Returns the range of rows to select.
 String globalInfo()
          Returns a string describing the object.
 String rowsTipText()
          Returns the tip text for this property.
 void setRows(Range value)
          Sets the range of rows to select.
 
Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractRowFinder
arrayToHashSet, check, compareTo, equals, findRows, forCommandLine, forName, getRowFinders, 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_Rows

protected Range m_Rows
the range of rows to select.

Constructor Detail

ByIndex

public ByIndex()
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

setRows

public void setRows(Range value)
Sets the range of rows to select.

Parameters:
value - the range

getRows

public Range getRows()
Returns the range of rows to select.

Returns:
the range

rowsTipText

public String rowsTipText()
Returns the tip text for this property.

Returns:
tip text for this property suitable for displaying in the gui

doFindRows

protected int[] doFindRows(SpreadSheet data)
Returns the rows of interest in the spreadsheet.

Specified by:
doFindRows in class AbstractRowFinder
Parameters:
data - the spreadsheet to inspect
Returns:
the rows of interest


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.