Package adams.data.conversion

Class SpreadSheetAnyColumnToString

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractSpreadSheetConversion

adams.data.conversion.AbstractInPlaceSpreadSheetConversion

adams.data.conversion.AbstractSpreadSheetColumnConverter

adams.data.conversion.SpreadSheetAnyColumnToString

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable

public class SpreadSheetAnyColumnToString
extends AbstractSpreadSheetColumnConverter

Converts the specified spreadsheet column from any type to string.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-column <adams.core.Index> (property: column)
    The column to convert to string; An index is a number starting with 1; the 
    following placeholders can be used as well: first, second, third, last_2,
     last_1, last
    default: first
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

m_Column, m_KeepFailed

Fields inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion

m_NoCopy

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

Method Summary

Modifier and Type	Method	Description
String	columnTipText()	Returns the tip text for this property.
protected void	convert(Cell cellOld, Cell cellNew)	Converts the cell's content to a new format.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

convert, defineOptions, getColumn, getKeepFailed, keepFailedTipText, preConvert, setColumn, setKeepFailed

Methods inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion

getNoCopy, noCopyTipText, setNoCopy

Methods inherited from class adams.data.conversion.AbstractSpreadSheetConversion

accepts, doConvert, generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, 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

Constructor Detail

SpreadSheetAnyColumnToString

public SpreadSheetAnyColumnToString()

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

columnTipText

public String columnTipText()

Returns the tip text for this property.

Specified by:

columnTipText in class AbstractSpreadSheetColumnConverter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

convert

protected void convert(Cell cellOld,
                       Cell cellNew)
                throws Exception

Converts the cell's content to a new format.

Specified by:

convert in class AbstractSpreadSheetColumnConverter

Parameters:

cellOld - the current cell

cellNew - the new cell with the converted content

Throws:

Exception - if conversion fails