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

Class NumericToken

java.lang.Object
com.pervasive.datarush.tokens.scalar.NumericToken
All Implemented Interfaces:
DataToken, NumericValued, ScalarToken, ScalarValued, TokenValued, ScalarTyped, TokenTyped, Serializable, Comparable<NumericToken>
public final class NumericToken extends Object implements ScalarToken, Comparable<NumericToken>
An immutable NumericValued object.
See Also:

  • Field Details

  • Constructor Details

    • NumericToken

      public NumericToken(NumericValued value)
      Constructs a new token with the numeric value in the given container.
      Parameters:
      value - a NumericValued containing the desired value

    • NumericToken

      public NumericToken(BigDecimal value)
      Constructs a new token with the given non-null numeric value specified as a java.math.BigDecimal. If a null valued token is desired, use NULL.
      Parameters:
      value - the numeric value of the token
      Throws:
      NullPointerException - if the value is null.

    • NumericToken

      public NumericToken(double value)
      Constructs a new token with the given non-null double value. If a null valued token is desired, use NULL.
      Parameters:
      value - the long value of the token

    • NumericToken

      public NumericToken(long value)
      Constructs a new token with the given non-null long value. If a null valued token is desired, use NULL.
      Parameters:
      value - the long value of the token

  • Method Details

    • compareTo

      public int compareTo(NumericToken that)
      Specified by:
      compareTo in interface Comparable<NumericToken>

    • 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 NumericToken parse(String value)
      Converts a string representation of a numeric value into a token.
      Parameters:
      value - a string value to interpret as a BigDecimal; see BigDecimal(String)
      Returns:
      a token with the specified value

    • 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