Package adams.data.spreadsheet.columnfinder

Class ByIndex

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.columnfinder.AbstractColumnFinder

adams.data.spreadsheet.columnfinder.ByIndex

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<ColumnFinder>, SizeOfHandler, ColumnFinder, Serializable

public class ByIndex
extends AbstractColumnFinder

Returns indices of columns that fall in the defined range.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnRange	m_Columns	the range of columns to select.

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

Method Summary

Modifier and Type	Method	Description
String	columnsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindColumns(SpreadSheet data)	Returns the columns of interest in the spreadsheet.
SpreadSheetColumnRange	getColumns()	Returns the range of columns to select.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setColumns(SpreadSheetColumnRange value)	Sets the range of columns to select.

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Columns

protected SpreadSheetColumnRange m_Columns

the range of columns to select.

Constructor Detail

ByIndex

public ByIndex()

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

setColumns

public void setColumns(SpreadSheetColumnRange value)

Sets the range of columns to select.

Parameters:

value - the range

getColumns

public SpreadSheetColumnRange getColumns()

Returns the range of columns to select.

Returns:

the range

columnsTipText

public String columnsTipText()

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 AbstractColumnFinder

Returns:

null if no info available, otherwise short string

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