adams.data.conversion
Class SpreadSheetObjectColumnToString

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.AbstractSpreadSheetConversion
                  adams.data.conversion.AbstractInPlaceSpreadSheetConversion
                      adams.data.conversion.AbstractSpreadSheetColumnConverter
                          adams.data.conversion.SpreadSheetObjectColumnToString

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable

public class SpreadSheetObjectColumnToString
extends AbstractSpreadSheetColumnConverter

Converts the specified spreadsheet column from the object type to string. Ignores cells that have no objects set, by setting them to missing.

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
 

-no-copy (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
 

-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
 

-handler <adams.data.spreadsheet.AbstractObjectHandler> (property: handler)
    The handler for converting the objects in the cells into their string representations.
    default: adams.data.spreadsheet.StringObjectHandler
 

Version:

$Revision: 6805 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractObjectHandler

m_Handler the object handler to use.

Fields inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

m_Column

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_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetObjectColumnToString()

Method Summary

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.
void	defineOptions() Adds options to the internal list of options.
AbstractObjectHandler	getHandler() Returns the format of the string used for parsing.
String	globalInfo() Returns a string describing the object.
String	handlerTipText() Returns the tip text for this property.
void	setHandler(AbstractObjectHandler value) Sets the format of the string used for parsing.

Methods inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

convert, getColumn, preConvert, setColumn

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, getInput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Handler

protected AbstractObjectHandler m_Handler

the object handler to use.

Constructor Detail

SpreadSheetObjectColumnToString

public SpreadSheetObjectColumnToString()

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 AbstractSpreadSheetColumnConverter

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.

setHandler

public void setHandler(AbstractObjectHandler value)

Sets the format of the string used for parsing.

Parameters:

value - the format

getHandler

public AbstractObjectHandler getHandler()

Returns the format of the string used for parsing.

Returns:

the format

handlerTipText

public String handlerTipText()

Returns the tip text for this property.

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