Package net.sf.saxon.value
Class BigDecimalValue
java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.DecimalValue
net.sf.saxon.value.BigDecimalValue
- All Implemented Interfaces:
Comparable<NumericValue>,Iterable<AtomicValue>,AtomicMatchKey,AtomicSequence,GroundedValue,IdentityComparable,Item,Sequence,ConversionResult
An implementation class for decimal values other than integers
- Since:
- 9.8. This class was previously named "DecimalValue". In 9.8 a new DecimalValue class is introduced, to more faithfully reflect the XDM type hierarchy, so that every instance of xs:decimal is now implemented as an instance of DecimalValue.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static classA Comparable that performs comparison of a DecimalValue either with another DecimalValue or with some other representation of an XPath numeric value -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BigDecimalstatic final BigDecimalstatic final intstatic final BigDecimalstatic final BigDecimalValuestatic final BigDecimalValuestatic final BigDecimalValuestatic final BigDecimalValueFields inherited from class net.sf.saxon.value.AtomicValue
typeLabelFields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
NaN_MATCH_KEY -
Constructor Summary
ConstructorsConstructorDescriptionBigDecimalValue(double in) Constructor supplying a doubleBigDecimalValue(long in) Constructor supplying a long integerBigDecimalValue(BigDecimal value) Constructor supplying a BigDecimal -
Method Summary
Modifier and TypeMethodDescriptionabs()Get the absolute value as defined by the XPath abs() functionintTest whether a number is a possible subscript into a sequence, that is, a whole number greater than zero and less than 2^31static booleanTest whether a string is castable to a decimal valueceiling()Implement the XPath ceiling() functionintcompareTo(long other) Compare the value to a longintcompareTo(NumericValue other) Compare the value to another numeric valuecopyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type labelstatic FastStringBufferdecimalToString(BigDecimal value, FastStringBuffer fsb) Convert a decimal value to a string, using the XPath rules for formattingbooleanGet the effective boolean value of the value.floor()Implement the XPath floor() functionGet the canonical lexical representation as defined in XML Schema.Get the valuedoubleGet the numeric value as a doublefloatGet the numeric value converted to a floatGet the value as a StringDetermine the primitive type of the value.Get an object that implements XML Schema comparison semanticsinthashCode()Get the hashCode.booleanDetermine whether two atomic values are identical, as determined by XML Schema rules.booleanDetermine whether the value is a whole number, that is, whether it compares equal to some integerlongReturn the numeric value as a Java long.static ConversionResultmakeDecimalValue(CharSequence in, boolean validate) Factory method to construct a DecimalValue from a stringnegate()Negate the valuestatic BigDecimalValueparse(CharSequence in) Factory method to construct a DecimalValue from a string, throwing an unchecked exception if the value is invalidround(int scale) Implement the XPath round() functionroundHalfToEven(int scale) Implement the XPath round-half-to-even() functionintsignum()Determine whether the value is negative, zero, or positiveMethods inherited from class net.sf.saxon.value.NumericValue
equals, getXPathComparable, isInteger, isNegativeZero, parseNumber, toStringMethods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, getCardinality, getComponent, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, identityHashCode, isIdentical, isNaN, itemAt, iterate, iterator, setTypeLabelMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomicMethods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materializeMethods inherited from interface net.sf.saxon.om.Item
isStreamed, reduce, subsequence, toShortStringMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
DIVIDE_PRECISION
public static final int DIVIDE_PRECISION- See Also:
-
BIG_DECIMAL_ONE_MILLION
-
BIG_DECIMAL_ONE_BILLION
-
ZERO
-
ONE
-
TWO
-
THREE
-
MAX_INT
-
-
Constructor Details
-
BigDecimalValue
Constructor supplying a BigDecimal- Parameters:
value- the value of the DecimalValue
-
BigDecimalValue
Constructor supplying a double- Parameters:
in- the value of the DecimalValue- Throws:
ValidationException- if the supplied value cannot be converted, typically because it is INF or NaN.
-
BigDecimalValue
public BigDecimalValue(long in) Constructor supplying a long integer- Parameters:
in- the value of the DecimalValue
-
-
Method Details
-
makeDecimalValue
Factory method to construct a DecimalValue from a string- Parameters:
in- the value of the DecimalValuevalidate- 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 a ValidationFailure encapsulating the error message if not.
-
parse
Factory method to construct a DecimalValue from a string, throwing an unchecked exception if the value is invalid- Parameters:
in- the lexical representation of the DecimalValue- Returns:
- the required DecimalValue
- Throws:
NumberFormatException- if the value is invalid
-
castableAsDecimal
Test whether a string is castable to a decimal value- Parameters:
in- the string to be tested- Returns:
- true if the string has the correct format for a decimal
-
copyAsSubType
Create a copy of this atomic value, with a different type label- Specified by:
copyAsSubTypein classAtomicValue- Parameters:
typeLabel- the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.- Returns:
- the copied value
-
getPrimitiveType
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.- Specified by:
getPrimitiveTypein classAtomicValue- Returns:
- the primitive type
-
getDoubleValue
public double getDoubleValue()Get the numeric value as a double- Specified by:
getDoubleValuein classNumericValue- Returns:
- A double representing this numeric value; NaN if it cannot be converted
-
getFloatValue
public float getFloatValue()Get the numeric value converted to a float- Specified by:
getFloatValuein classNumericValue- Returns:
- a float representing this numeric value; NaN if it cannot be converted
-
longValue
Return the numeric value as a Java long.- Specified by:
longValuein classNumericValue- Returns:
- the numeric value as a Java long. This performs truncation towards zero.
- Throws:
XPathException- if the value cannot be converted
-
getDecimalValue
Get the value- Specified by:
getDecimalValuein classNumericValue- Returns:
- a decimal representing this numeric value;
-
hashCode
public int hashCode()Get the hashCode. This must conform to the rules for other NumericValue hashcodes- Specified by:
hashCodein classNumericValue- Returns:
- the hash code of the numeric value
- See Also:
-
effectiveBooleanValue
public boolean effectiveBooleanValue()Description copied from class:NumericValueGet the effective boolean value of the value. This override of this method throws no exceptions.- Specified by:
effectiveBooleanValuein interfaceGroundedValue- Specified by:
effectiveBooleanValuein classNumericValue- Returns:
- true, unless the value is boolean false, numeric zero, or zero-length string
-
getCanonicalLexicalRepresentation
Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For xs:decimal, the canonical representation always contains a decimal point.- Specified by:
getCanonicalLexicalRepresentationin interfaceAtomicSequence- Overrides:
getCanonicalLexicalRepresentationin classAtomicValue- Returns:
- the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
-
getPrimitiveStringValue
Get the value as a String- Specified by:
getPrimitiveStringValuein classAtomicValue- Returns:
- a String representation of the value
-
decimalToString
Convert a decimal value to a string, using the XPath rules for formatting- Parameters:
value- the decimal value to be convertedfsb- the FastStringBuffer to which the value is to be appended- Returns:
- the supplied FastStringBuffer, suitably populated
-
negate
Negate the value- Specified by:
negatein classNumericValue- Returns:
- a value, of the same type as the original, with its sign inverted
-
floor
Implement the XPath floor() function- Specified by:
floorin classNumericValue- Returns:
- a value, of the same type as that supplied, rounded towards minus infinity
-
ceiling
Implement the XPath ceiling() function- Specified by:
ceilingin classNumericValue- Returns:
- a value, of the same type as that supplied, rounded towards plus infinity
-
round
Implement the XPath round() function- Specified by:
roundin classNumericValue- Parameters:
scale- the number of decimal places required in the result (supply 0 for rounding to an integer)- Returns:
- a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)
-
roundHalfToEven
Implement the XPath round-half-to-even() function- Specified by:
roundHalfToEvenin classNumericValue- 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 int signum()Determine whether the value is negative, zero, or positive- Specified by:
signumin classNumericValue- 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:
isWholeNumberin classNumericValue- Returns:
- true if the value is a whole number
-
asSubscript
public int asSubscript()Test whether a number is a possible subscript into a sequence, that is, a whole number greater than zero and less than 2^31- Specified by:
asSubscriptin classNumericValue- Returns:
- the number as an int if it is a possible subscript, or -1 otherwise
-
abs
Get the absolute value as defined by the XPath abs() function- Specified by:
absin classNumericValue- Returns:
- the absolute value
- Since:
- 9.2
-
compareTo
Compare the value to another numeric value- Specified by:
compareToin interfaceComparable<NumericValue>- Overrides:
compareToin classNumericValue- 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, or if either value is NaN. Where NaN values are involved, they should be handled by the caller before invoking this method.
-
compareTo
public int compareTo(long other) Compare the value to a long- Specified by:
compareToin classNumericValue- 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
-
getSchemaComparable
Get an object that implements XML Schema comparison semantics- Specified by:
getSchemaComparablein interfaceAtomicSequence- Specified by:
getSchemaComparablein classAtomicValue- Returns:
- a Comparable that follows XML Schema comparison rules
-
isIdentical
Determine whether two atomic values are identical, as determined by XML Schema rules. This is a stronger test than equality (even schema-equality); for example two dateTime values are not identical unless they are in the same timezone.Note that even this check ignores the type annotation of the value. The integer 3 and the short 3 are considered identical, even though they are not fully interchangeable. "Identical" means the same point in the value space, regardless of type annotation.
NaN is identical to itself.
- Overrides:
isIdenticalin classAtomicValue- Parameters:
v- the other value to be compared with this one- Returns:
- true if the two values are identical, false otherwise.
-