Package adams.data.conversion

Class BaseDateTimeToString

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, ConversionToString, GrammarSupplier, Serializable
    public class BaseDateTimeToString
extends AbstractConversionToString
implements GrammarSupplier
    Turns a BaseDateTime format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).

    Example: 2015-12-01 07:13:12 +3 MINUTE

    (<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR|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.BaseDateTime> (property: start)
    The start date to use in the evaluation.
    default: -INF
 
    -end <adams.core.base.BaseDateTime> (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 Detail

      • m_Start

        protected BaseDateTime m_Start
        the start date to use as basis for the evaluation.

      • m_End

        protected BaseDateTime 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

      • BaseDateTimeToString

        public BaseDateTimeToString()

    • Method Detail

      • getGrammar

        public String getGrammar()
        Returns a string representation of the grammar.
        Specified by:
        getGrammar in interface GrammarSupplier
        Returns:
        the grammar, null if not available

      • setStart

        public void setStart​(BaseDateTime value)
        Sets the start date to use in the evaluation.
        Parameters:
        value - the date

      • getStart

        public BaseDateTime 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​(BaseDateTime value)
        Sets the end date to use in the evaluation.
        Parameters:
        value - the date

      • getEnd

        public BaseDateTime 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.