Package adams.data.conversion

Class SpreadSheetStringColumnToTime

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

All Implemented Interfaces:

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

public class SpreadSheetStringColumnToTime
extends AbstractSpreadSheetColumnConverter

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

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

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

-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: column)
    The column to convert to date; An index is a number starting with 1; column 
    names (case-sensitive) as well as the following placeholders can be used:
     first, second, third, last_2, last_1, last; numeric indices can be enforced 
    by preceding them with '#' (eg '#12'); column names can be surrounded by 
    double quotes.
    default: first
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 

-keep-failed <boolean> (property: keepFailed)
    Whether to keep the original value of cells which conversion has failed 
    rather than setting them to missing.
    default: false
 

-format <adams.data.DateFormatString> (property: format)
    The format string used for parsing the strings.
    default: HH:mm:ss
    more: http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DateFormatString	m_Format	the format to use.
protected DateFormat	m_Formatter	the formatter in use.

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

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.
void	defineOptions()	Adds options to the internal list of options.
String	formatTipText()	Returns the tip text for this property.
DateFormatString	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(DateFormatString value)	Sets the format of the string used for parsing.

Methods inherited from class adams.data.conversion.AbstractSpreadSheetColumnConverter

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

Field Detail

m_Format

protected DateFormatString m_Format

the format to use.

m_Formatter

protected transient DateFormat m_Formatter

the formatter in use.

Constructor Detail

SpreadSheetStringColumnToTime

public SpreadSheetStringColumnToTime()

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

Sets the format of the string used for parsing.

Parameters:

value - the format

getFormat

public DateFormatString 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