adams.data.conversion
Class SpreadSheetStringColumnToLong

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.SpreadSheetStringColumnToLong

All Implemented Interfaces:

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

public class SpreadSheetStringColumnToLong
extends AbstractSpreadSheetColumnConverter

Converts the specified spreadsheet column from string to long, according to the provided format.
For more information on the format, see Javadoc of 'java.text.DecimalFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html

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 long; 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
 

-format <adams.data.DecimalFormatString> (property: format)
    The format string used for parsing the strings.
    default: 0
 

Version:

$Revision: 6240 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected DecimalFormatString	m_Format the format to use.
protected DecimalFormat	m_Formatter the formatter 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

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetStringColumnToLong()

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.
String	formatTipText() Returns the tip text for this property.
DecimalFormatString	getFormat() Returns the format of the string used for parsing.
String	globalInfo() Returns a string describing the object.
protected void	preConvert(SpreadSheet input) Prepares the conversion.
void	setFormat(DecimalFormatString value) Sets the format of the string used for parsing.

Methods inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

convert, getColumn, 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

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_Format

protected DecimalFormatString m_Format

the format to use.

m_Formatter

protected transient DecimalFormat m_Formatter

the formatter to use.

Constructor Detail

SpreadSheetStringColumnToLong

public SpreadSheetStringColumnToLong()

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.

setFormat

public void setFormat(DecimalFormatString value)

Sets the format of the string used for parsing.

Parameters:

value - the format

getFormat

public DecimalFormatString getFormat()

Returns the format of the string used for parsing.

Returns:

the format

formatTipText

public String formatTipText()

Returns the tip text for this property.

Returns:

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

preConvert

protected void preConvert(SpreadSheet input)

Prepares the conversion.

Overrides:

preConvert in class AbstractSpreadSheetColumnConverter

Parameters:

input - the spreadsheet to convert

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