adams.data.spreadsheet.columnfinder
Class FilteredColumnFinder

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.data.spreadsheet.columnfinder.AbstractColumnFinder
              extended by adams.data.spreadsheet.columnfinder.FilteredColumnFinder
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<ColumnFinder>, SizeOfHandler, ColumnFinder, Serializable

public class FilteredColumnFinder
extends AbstractColumnFinder

Filters the data first before applying the actual finder to locate the columns.

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

Field Summary
protected  ColumnFinder m_Filter
          the ColumnFinder to filter the data with first.
protected  ColumnFinder m_Finder
          the ColumnFinder to use on the filtered data.
 
Fields inherited from class adams.core.option.AbstractOptionHandler
m_DebugLevel, m_OptionManager
 
Constructor Summary
FilteredColumnFinder()
           
 
Method Summary
 void defineOptions()
          Adds options to the internal list of options.
protected  int[] doFindColumns(SpreadSheet data)
          Returns the columns of interest in the spreadsheet.
 String filterTipText()
          Returns the tip text for this property.
 String finderTipText()
          Returns the tip text for this property.
 ColumnFinder getFilter()
          Returns the column finder to filter the data with first.
 ColumnFinder getFinder()
          Returns the column finder to use on the filtered data.
 String globalInfo()
          Returns a string describing the object.
 void setFilter(ColumnFinder value)
          Sets the column finder to filter the data with first.
 void setFinder(ColumnFinder value)
          Sets the column finder to use on the filtered data.
 
Methods inherited from class adams.data.spreadsheet.columnfinder.AbstractColumnFinder
arrayToHashSet, check, compareTo, equals, filter, filter, findColumns, forCommandLine, forName, getColumnFinders, 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_Filter

protected ColumnFinder m_Filter
the ColumnFinder to filter the data with first.


m_Finder

protected ColumnFinder m_Finder
the ColumnFinder to use on the filtered data.

Constructor Detail

FilteredColumnFinder

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

setFilter

public void setFilter(ColumnFinder value)
Sets the column finder to filter the data with first.

Parameters:
value - the column finder

getFilter

public ColumnFinder getFilter()
Returns the column finder to filter the data with first.

Returns:
the column finder

filterTipText

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

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

setFinder

public void setFinder(ColumnFinder value)
Sets the column finder to use on the filtered data.

Parameters:
value - the column finder

getFinder

public ColumnFinder getFinder()
Returns the column finder to use on the filtered data.

Returns:
the column finder

finderTipText

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

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

doFindColumns

protected int[] doFindColumns(SpreadSheet data)
Returns the columns of interest in the spreadsheet.

Specified by:
doFindColumns in class AbstractColumnFinder
Parameters:
data - the spreadsheet to inspect
Returns:
the columns of interest


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