Package adams.data.conversion

Class SpreadSheetCellFinderToPositions

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.SpreadSheetCellFinderToPositions

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

@Deprecated
public class SpreadSheetCellFinderToPositions
extends AbstractConversion

Deprecated.

Turns the cells that the specified cell finder locates into an array of cell positions (like 'A2').

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-cell-finder <adams.data.spreadsheet.cellfinder.CellFinder> (property: cellFinder)
    The cell finder to use.
    default: adams.data.spreadsheet.cellfinder.SingleCell
 

Version:

$Revision: 6556 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CellFinder	m_CellFinder	Deprecated. the CellFinder to apply.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

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
SpreadSheetCellFinderToPositions()	Deprecated.

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Deprecated. Returns the class that is accepted as input.
String	cellFinderTipText()	Deprecated. Returns the tip text for this property.
void	defineOptions()	Deprecated. Adds options to the internal list of options.
protected Object	doConvert()	Deprecated. Performs the actual conversion.
Class	generates()	Deprecated. Returns the class that is generated as output.
CellFinder	getCellFinder()	Deprecated. Returns the cell finder in use.
String	getQuickInfo()	Deprecated. Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Deprecated. Returns a string describing the object.
void	setCellFinder(CellFinder value)	Deprecated. Sets the cell finder to use.

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_CellFinder

protected CellFinder m_CellFinder

Deprecated.

the CellFinder to apply.

Constructor Detail

SpreadSheetCellFinderToPositions

public SpreadSheetCellFinderToPositions()

Deprecated.

Method Detail

globalInfo

public String globalInfo()

Deprecated.

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

Deprecated.

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setCellFinder

public void setCellFinder(CellFinder value)

Deprecated.

Sets the cell finder to use.

Parameters:

value - the cell finder

getCellFinder

public CellFinder getCellFinder()

Deprecated.

Returns the cell finder in use.

Returns:

the cell finder

cellFinderTipText

public String cellFinderTipText()

Deprecated.

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getQuickInfo

public String getQuickInfo()

Deprecated.

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractConversion

Returns:

null if no info available, otherwise short string

accepts

public Class accepts()

Deprecated.

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Deprecated.

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Deprecated.

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion