Package net.sf.saxon.value

Class DecimalValue

    • Field Detail

      • BIG_DECIMAL_ONE

        public static final java.math.BigDecimal BIG_DECIMAL_ONE

      • BIG_INTEGER_TEN

        public static final java.math.BigInteger BIG_INTEGER_TEN

      • BIG_DECIMAL_ONE_MILLION

        public static final java.math.BigDecimal BIG_DECIMAL_ONE_MILLION

    • Constructor Detail

      • DecimalValue

        public DecimalValue​(java.math.BigDecimal value)
        Constructor supplying a BigDecimal
        Parameters:
        value - the value of the DecimalValue

      • DecimalValue

        public DecimalValue​(long in)
        Constructor supplying a long integer
        Parameters:
        in - the value of the DecimalValue

    • Method Detail

      • makeDecimalValue

        public static AtomicValue makeDecimalValue​(java.lang.CharSequence in,
                                           boolean validate)
        Factory method to construct a DecimalValue from a string
        Parameters:
        in - the value of the DecimalValue
        validate - true if validation is required; false if the caller knows that the value is valid
        Returns:
        the required DecimalValue if the input is valid, or an ErrorValue encapsulating the error message if not.

      • castableAsDecimal

        public static boolean castableAsDecimal​(java.lang.CharSequence in)
        Test whether a string is castable to a decimal value

      • getValue

        public java.math.BigDecimal getValue()
        Get the value

      • hashCode

        public int hashCode()
        Get the hashCode. This must conform to the rules for other NumericValue hashcodes
        Specified by:
        hashCode in class NumericValue
        Returns:
        the hash code of the numeric value
        See Also:
        NumericValue.hashCode()

      • effectiveBooleanValue

        public boolean effectiveBooleanValue​(XPathContext context)
        Description copied from class: AtomicValue
        Get the effective boolean value of the value
        Specified by:
        effectiveBooleanValue in interface Expression
        Overrides:
        effectiveBooleanValue in class AtomicValue
        Parameters:
        context - the evaluation context (not used in this implementation)
        Returns:
        true, unless the value is boolean false, numeric zero, or zero-length string

      • convertPrimitive

        public AtomicValue convertPrimitive​(BuiltInAtomicType requiredType,
                                    boolean validate,
                                    XPathContext context)
        Convert to target data type
        Specified by:
        convertPrimitive in class AtomicValue
        Parameters:
        requiredType - type code of the required atomic type
        validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.
        context - The conversion context to be used. This is required at present only when converting to a date or time: it provides the implicit timezone.
        Returns:
        the result of the conversion, if successful. If unsuccessful, the value returned will be a ValidationErrorValue. The caller must check for this condition. No exception is thrown, instead the exception will be encapsulated within the ValidationErrorValue.

      • decimalToString

        public static java.lang.CharSequence decimalToString​(java.math.BigDecimal value)

      • negate

        public NumericValue negate()
        Negate the value
        Specified by:
        negate in class NumericValue
        Returns:
        a value, of the same type as the original, with its sign inverted

      • floor

        public NumericValue floor()
        Implement the XPath floor() function
        Specified by:
        floor in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards minus infinity

      • ceiling

        public NumericValue ceiling()
        Implement the XPath ceiling() function
        Specified by:
        ceiling in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards plus infinity

      • round

        public NumericValue round()
        Implement the XPath round() function
        Specified by:
        round in class NumericValue
        Returns:
        a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)

      • roundHalfToEven

        public NumericValue roundHalfToEven​(int scale)
        Implement the XPath round-half-to-even() function
        Specified by:
        roundHalfToEven in class NumericValue
        Parameters:
        scale - the decimal position for rounding: e.g. 2 rounds to a multiple of 0.01, while -2 rounds to a multiple of 100
        Returns:
        a value, of the same type as the original, rounded towards the nearest multiple of 10**(-scale), with rounding towards the nearest even number if two values are equally near

      • signum

        public double signum()
        Determine whether the value is negative, zero, or positive
        Specified by:
        signum in class NumericValue
        Returns:
        -1 if negative, 0 if zero, +1 if positive, NaN if NaN

      • isWholeNumber

        public boolean isWholeNumber()
        Determine whether the value is a whole number, that is, whether it compares equal to some integer
        Specified by:
        isWholeNumber in class NumericValue
        Returns:
        true if the value is a whole number

      • arithmetic

        public NumericValue arithmetic​(int operator,
                               NumericValue other,
                               XPathContext context)
                        throws XPathException
        Evaluate a binary arithmetic operator.
        Specified by:
        arithmetic in class NumericValue
        Parameters:
        operator - the binary arithmetic operation to be performed. Uses the constants defined in the Tokenizer class
        other - the other operand
        Returns:
        the result of the arithmetic operation
        Throws:
        XPathException - if an arithmetic error occurs
        See Also:
        Tokenizer

      • compareTo

        public int compareTo​(java.lang.Object other)
        Compare the value to another numeric value
        Specified by:
        compareTo in interface java.lang.Comparable
        Overrides:
        compareTo in class NumericValue
        Parameters:
        other - The other numeric value
        Returns:
        -1 if this one is the lower, 0 if they are numerically equal, +1 if this one is the higher.

      • compareTo

        public int compareTo​(long other)
        Compare the value to a long
        Specified by:
        compareTo in class NumericValue
        Parameters:
        other - the value to be compared with
        Returns:
        -1 if this is less, 0 if this is equal, +1 if this is greater or if this is NaN