Module datarush.library
Package com.pervasive.datarush.tokens.scalar

Class TimeToken

    • Field Detail

      • NULL

        public static final TimeToken NULL
        A null valued TimeToken

      • ZERO_VALUE

        public static final int ZERO_VALUE
        The time representing a zero value, midnight.
        See Also:
        Constant Field Values

      • ZERO

        public static final TimeToken ZERO
        A zero valued TimeToken

    • Constructor Detail

      • TimeToken

        public TimeToken​(TimeValued value)
        Constructs a new token with the time value in the given container.
        Parameters:
        value - a TimeValued containing the desired value

      • TimeToken

        public TimeToken​(int dayMillis)
        Constructs a new token with the non-null time value specified as the number of milliseconds since midnight. If a null valued token is desired, use NULL.
        Parameters:
        dayMillis - the time value of the token, expressed as the number milliseconds elapsed since midnight

      • TimeToken

        public TimeToken​(int hourOfDay,
                 int minuteOfHour,
                 int secondOfMinute)
        Constructs a new token with the non-null time of day. If a null valued token is desired, use NULL.
        Parameters:
        hourOfDay - the hour portion of the time. Hours are expressed in 24-hour format, ranging from 0 to 23.
        minuteOfHour - the minute portion of the time
        secondOfMinute - the seconds portion of the time

      • TimeToken

        public TimeToken​(int hourOfDay,
                 int minuteOfHour,
                 int secondOfMinute,
                 int subsecMillis)
        Constructs a new token with the non-null time of day. If a null valued token is desired, use NULL.
        Parameters:
        hourOfDay - the hour portion of the time. Hours are expressed in 24-hour format, ranging from 0 to 23.
        minuteOfHour - the minute portion of the time
        secondOfMinute - the seconds portion of the time
        subsecMillis - the milliseconds portion of the time

      • TimeToken

        public TimeToken​(TimeOfDay time)
        Constructs a new token with the non-null time of day. If a null valued token is desired, use NULL.
        Parameters:
        date - the time of day of the token

    • Method Detail

      • equals

        public boolean equals​(Object obj)
        Description copied from interface: DataToken
        Indicates whether another object is equal to this token. Two null valued tokens are considered equal. This differs from the behavior of TokenComparator.equal(TokenValued,TokenValued) but makes it possible to store DataTokens in Maps.
        Specified by:
        equals in interface DataToken
        Overrides:
        equals in class Object
        Parameters:
        obj - the object to compare
        Returns:
        true if the other object is a token of the same type and contains the same value, false otherwise.

      • hashCode

        public int hashCode()
        Description copied from interface: DataToken
        Returns a hash code for the token. This value is guaranteed to be consistent with that returned by TokenConverter.asHashCode(TokenValued).
        Specified by:
        hashCode in interface DataToken
        Overrides:
        hashCode in class Object
        Returns:
        a hash code value for the token

      • parse

        public static TimeToken parse​(String value)
        Converts a string representation of a time value into a token.
        Parameters:
        value - a string value to interpret as a time; this must be in ISO8601 format.
        Returns:
        a token with the specified value

      • asDayMillis

        public final int asDayMillis()
        Description copied from interface: TimeValued
        Gets the contained time value as the number of milliseconds elapsed since midnight.
        Specified by:
        asDayMillis in interface TimeValued
        Returns:
        the contained value as milliseconds since midnight. If null valued, as indicated by TokenValued.isNull(), 0 is returned.

      • asTimeOfDay

        public final TimeOfDay asTimeOfDay()
        Description copied from interface: TimeValued
        Gets the contained time value. This value represents the timezone free time portion of a timestamp.
        Specified by:
        asTimeOfDay in interface TimeValued
        Returns:
        the contained value. If null valued, as indicated by TokenValued.isNull(), null is returned.

      • isZero

        public final boolean isZero()
        Description copied from interface: ScalarValued
        Indicates whether the value is the zero value for the type. Zero values are not stored in sparse representation formats.
        Specified by:
        isZero in interface ScalarValued
        Returns:
        true if the value is the zero value, false otherwise.

      • isNull

        public final boolean isNull()
        Description copied from interface: TokenValued
        Indicates whether the token is null valued. Tokens support null values analogous to SQL. Before accessing the value of the container, it is usually best to ensure it is not null valued using this method.
        Specified by:
        isNull in interface TokenValued
        Returns:
        true if the token is null valued, false otherwise