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

Class TimeRegister

java.lang.Object
com.pervasive.datarush.tokens.scalar.TimeRegister
All Implemented Interfaces:
DataRegister, ScalarRegister, ScalarSettable, ScalarValued, TimeSettable, TimeValued, TokenSettable, TokenValued, ScalarTyped, TokenTyped, Serializable
public final class TimeRegister extends Object implements ScalarRegister, TimeSettable
A mutable TimeValued object.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimeRegister()
    Creates a new null-valued register.

  • Method Summary

    Modifier and Type
    Method
    Description
    final int
    asDayMillis()
    Gets the contained time value as the number of milliseconds elapsed since midnight.
    final TimeOfDay
    asTimeOfDay()
    Gets the contained time value.
    final ScalarTokenType
    getType()
    Gets the data type of the token.
    final boolean
    isNull()
    Indicates whether the token is null valued.
    final boolean
    isZero()
    Indicates whether the value is the zero value for the type.
    void
    set(int millis)
    Sets the container to a time value specified as the number of milliseconds since midnight.
    void
    set(TimeOfDay time)
    Sets the container to the specified time of day.
    void
    set(TokenValued value)
    Sets the contained value to the given token value.
    void
    setNull()
    Sets the contained value to be null valued.
    void
    setZero()
    Sets the contained value to be zero valued.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.pervasive.datarush.types.ScalarTyped

    getType

    Methods inherited from interface com.pervasive.datarush.tokens.scalar.ScalarValued

    getType, isZero

    Methods inherited from interface com.pervasive.datarush.tokens.TokenValued

    isNull

  • Constructor Details

    • TimeRegister

      public TimeRegister()
      Creates a new null-valued register.

  • Method Details

    • setNull

      public void setNull()
      Description copied from interface: TokenSettable
      Sets the contained value to be null valued.
      Specified by:
      setNull in interface TokenSettable

    • setZero

      public void setZero()
      Description copied from interface: TokenSettable
      Sets the contained value to be zero valued.
      Specified by:
      setZero in interface TokenSettable

    • set

      public void set(int millis)
      Description copied from interface: TimeSettable
      Sets the container to a time value specified as the number of milliseconds since midnight.
      Specified by:
      set in interface TimeSettable
      Parameters:
      millis - time value to which to set the container, expressed as the number of milliseconds since midnight

    • set

      public void set(TimeOfDay time)
      Description copied from interface: TimeSettable
      Sets the container to the specified time of day.
      Specified by:
      set in interface TimeSettable
      Parameters:
      time - the time value to which to set the container

    • set

      public void set(TokenValued value)
      Description copied from interface: TokenSettable
      Sets the contained value to the given token value. The given value must have a type compatible with this object.
      Specified by:
      set in interface TokenSettable
      Parameters:
      value - the value to which to set the container

    • getType

      public final ScalarTokenType getType()
      Description copied from interface: TokenValued
      Gets the data type of the token. This type will dictate the valid values that can be contained.
      Specified by:
      getType in interface ScalarTyped
      Specified by:
      getType in interface ScalarValued
      Specified by:
      getType in interface TokenTyped
      Specified by:
      getType in interface TokenValued
      Returns:
      the token type.

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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