Package adams.data.spreadsheet.rowfinder

Class ByContentType

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowfinder.AbstractRowFinder

adams.data.spreadsheet.rowfinder.ByContentType

All Implemented Interfaces:

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

public class ByContentType
extends AbstractRowFinder

Returns indices of rows which match the specified content type.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetColumnIndex	m_AttributeIndex	the attribute index to work on.
protected Cell.ContentType	m_ContentType	the content type to look for.

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

Method Summary

Modifier and Type	Method	Description
String	attributeIndexTipText()	Returns the tip text for this property.
String	contentTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFindRows(SpreadSheet data)	Returns the rows of interest in the spreadsheet.
SpreadSheetColumnIndex	getAttributeIndex()	Returns the index of the column to perform the matching on.
Cell.ContentType	getContentType()	Returns the content type to look for.
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	setAttributeIndex(SpreadSheetColumnIndex value)	Sets the index of the column to perform the matching on.
void	setContentType(Cell.ContentType value)	Sets the content type to look for.

Methods inherited from class adams.data.spreadsheet.rowfinder.AbstractRowFinder

arrayToHashSet, check, compareTo, equals, filter, findRows, forCommandLine, forName, getRowFinders, 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_AttributeIndex

protected SpreadSheetColumnIndex m_AttributeIndex

the attribute index to work on.

m_ContentType

protected Cell.ContentType m_ContentType

the content type to look for.

Constructor Detail

ByContentType

public ByContentType()

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

setAttributeIndex

public void setAttributeIndex(SpreadSheetColumnIndex value)

Sets the index of the column to perform the matching on.

Parameters:

value - the index

getAttributeIndex

public SpreadSheetColumnIndex getAttributeIndex()

Returns the index of the column to perform the matching on.

Returns:

the index

attributeIndexTipText

public String attributeIndexTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setContentType

public void setContentType(Cell.ContentType value)

Sets the content type to look for.

Parameters:

value - the type

getContentType

public Cell.ContentType getContentType()

Returns the content type to look for.

Returns:

the type

contentTypeTipText

public String contentTypeTipText()

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 AbstractRowFinder

Returns:

null if no info available, otherwise short string

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