Package adams.flow.transformer

Class DateTimeTypeDifference

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class DateTimeTypeDifference
extends AbstractTransformer
    Computes the difference between the two date/time types of the incoming array (of length 2) by subtracting the second element from the first one.

    Input/output:
    - accepts:
       java.util.Date[]
    - generates:
       java.lang.Double


    -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
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: DateTimeTypeDifference
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -input-datetime-type <MSECS|MSECS_LONG|SECONDS|SECONDS_LONG|DATE|DATETIME|DATETIMEMSEC|TIME|TIMEMSEC|BASEDATE|BASEDATETIME|BASEDATETIMEMSEC|BASETIME|BASETIMEMSEC|SERIAL_DATETIME|SERIAL_DATETIME_LONG> (property: inputDateTimeType)
    The date/time type of the input data.
    default: DATE
 
    -output-datetime-type <MSECS|MSECS_LONG|SECONDS|SECONDS_LONG|DATE|DATETIME|DATETIMEMSEC|TIME|TIMEMSEC|BASEDATE|BASEDATETIME|BASEDATETIMEMSEC|BASETIME|BASETIMEMSEC|SERIAL_DATETIME|SERIAL_DATETIME_LONG> (property: outputDateTimeType)
    The date/time type of the output data.
    default: MSECS
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_InputDateTimeType

        protected DateTimeType m_InputDateTimeType
        the datetime type of the input.

      • m_OutputDateTimeType

        protected DateTimeType m_OutputDateTimeType
        the datetime type of the output.

      • m_ConversionInput

        protected ConvertDateTimeType m_ConversionInput
        the conversion in use for the input.

      • m_ConversionOutput

        protected ConvertDateTimeType m_ConversionOutput
        the conversion in use for the output.

    • Constructor Detail

      • DateTimeTypeDifference

        public DateTimeTypeDifference()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setInputDateTimeType

        public void setInputDateTimeType​(DateTimeType value)
        Sets the input date/time type.
        Parameters:
        value - the type

      • getInputDateTimeType

        public DateTimeType getInputDateTimeType()
        Returns the input date/time type.
        Returns:
        the type

      • inputDateTimeTypeTipText

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

      • setOutputDateTimeType

        public void setOutputDateTimeType​(DateTimeType value)
        Sets the output date/time type.
        Parameters:
        value - the type

      • getOutputDateTimeType

        public DateTimeType getOutputDateTimeType()
        Returns the output date/time type.
        Returns:
        the type

      • outputDateTimeTypeTipText

        public String outputDateTimeTypeTipText()
        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 the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message