Package adams.data.conversion

Class BaseDateToString

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionToString

adams.data.conversion.BaseDateToString

All Implemented Interfaces:

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

public class BaseDateToString
extends AbstractConversionToString
implements GrammarSupplier

Turns a BaseDate format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).

Example: 2015-12-01 +3 DAY

(<date>|NOW|-INF|+INF|START|END) [expr (DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER

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

-start <adams.core.base.BaseDate> (property: start)
    The start date to use in the evaluation.
    default: -INF
 

-end <adams.core.base.BaseDate> (property: end)
    The end date to use in the evaluation.
    default: +INF
 

-business-days <MONDAY_TO_FRIDAY> (property: businessDays)
    How to interpret business days.
    default: MONDAY_TO_FRIDAY
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BusinessDays	m_BusinessDays	how to interpret business days.
protected BaseDate	m_End	the end date to use as basis for the evaluation.
protected BaseDate	m_Start	the start date to use as basis for the evaluation.

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

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	businessDaysTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
String	endTipText()	Returns the tip text for this property.
BusinessDays	getBusinessDays()	Returns what business days to use.
BaseDate	getEnd()	Returns the end date used in the evaluation.
String	getGrammar()	Returns a string representation of the grammar.
BaseDate	getStart()	Returns the start date used in the evaluation.
String	globalInfo()	Returns a string describing the object.
void	setBusinessDays(BusinessDays value)	Sets what business days to use.
void	setEnd(BaseDate value)	Sets the end date to use in the evaluation.
void	setStart(BaseDate value)	Sets the start date to use in the evaluation.
String	startTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversionToString

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

cleanUp

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Methods inherited from interface adams.core.Stoppable

stopExecution

Field Detail

m_Start

protected BaseDate m_Start

the start date to use as basis for the evaluation.

m_End

protected BaseDate m_End

the end date to use as basis for the evaluation.

m_BusinessDays

protected BusinessDays m_BusinessDays

how to interpret business days.

Constructor Detail

BaseDateToString

public BaseDateToString()

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

getGrammar

public String getGrammar()

Returns a string representation of the grammar.

Specified by:

getGrammar in interface GrammarSupplier

Returns:

the grammar, null if not available

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setStart

public void setStart(BaseDate value)

Sets the start date to use in the evaluation.

Parameters:

value - the date

getStart

public BaseDate getStart()

Returns the start date used in the evaluation.

Returns:

the date

startTipText

public String startTipText()

Returns the tip text for this property.

Returns:

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

setEnd

public void setEnd(BaseDate value)

Sets the end date to use in the evaluation.

Parameters:

value - the date

getEnd

public BaseDate getEnd()

Returns the end date used in the evaluation.

Returns:

the date

endTipText

public String endTipText()

Returns the tip text for this property.

Returns:

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

setBusinessDays

public void setBusinessDays(BusinessDays value)

Sets what business days to use.

Parameters:

value - the type

getBusinessDays

public BusinessDays getBusinessDays()

Returns what business days to use.

Returns:

the type

businessDaysTipText

public String businessDaysTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion