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

Class NumericRegister

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

  • Constructor Details

    • NumericRegister

      public NumericRegister()
      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(BigDecimal value)
      Description copied from interface: NumericSettable
      Sets the container to the given numeric value.
      Specified by:
      set in interface NumericSettable
      Parameters:
      value - numeric 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.

    • asBigDecimal

      public final BigDecimal asBigDecimal()
      Description copied from interface: NumericValued
      Gets the contained numeric value.
      Specified by:
      asBigDecimal in interface NumericValued
      Returns:
      the contained value as a java.math.BigDecimal. 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