Package adams.data.conversion

Class StringToDateTimeType

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, ConversionFromString, Serializable
    public class StringToDateTimeType
extends AbstractConversionFromString
    Parses a string and turns it into an instance of the specified date/time type. The string may contain variables, which get expanded at conversion time. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -format <adams.data.DateFormatString> (property: format)
    The format for parsing the date/time string.
    default: yyyy-MM-dd
    more: https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
 
    -datetime-type <MSECS|MSECS_LONG|SECONDS|SECONDS_LONG|DATE|DATETIME|DATETIMEMSEC|TIME|TIMEMSEC|BASEDATE|BASEDATETIME|BASEDATETIMEMSEC|BASETIME|BASETIMEMSEC|SERIAL_DATETIME|SERIAL_DATETIME_LONG> (property: dateTimeType)
    The date/time type to generate from the string.
    default: DATE
 
    -use-base-parsing <boolean> (property: useBaseParsing)
    If enabled, uses the parsing capability of the BaseTime, BaseDate, BaseDateTime
    classes to parse the string rather than the specified format string (string
    must be in the appropriate format).
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DateTimeType

        protected DateTimeType m_DateTimeType
        the datetime type to convert.

      • m_UseBaseParsing

        protected boolean m_UseBaseParsing
        whether to use the base* class's parsing.

      • m_Formatter

        protected transient DateFormat m_Formatter
        the formatter.

    • Constructor Detail

      • StringToDateTimeType

        public StringToDateTimeType()

    • Method Detail

      • setFormat

        public void setFormat​(DateFormatString value)
        Sets the format for parsing the date/time string.
        Parameters:
        value - the format

      • getFormat

        public DateFormatString getFormat()
        Returns the format for parsing the date/time string.
        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.

      • setDateTimeType

        public void setDateTimeType​(DateTimeType value)
        Sets the date/time type to generate.
        Parameters:
        value - the type

      • getDateTimeType

        public DateTimeType getDateTimeType()
        Returns the date/time type to generate.
        Returns:
        the type

      • dateTimeTypeTipText

        public String dateTimeTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUseBaseParsing

        public void setUseBaseParsing​(boolean value)
        Sets the date/time type to generate.
        Parameters:
        value - the type

      • getUseBaseParsing

        public boolean getUseBaseParsing()
        Returns the date/time type to generate.
        Returns:
        the type

      • useBaseParsingTipText

        public String useBaseParsingTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.