Package net.sf.saxon.value
Class DecimalValue
- java.lang.Object
-
- net.sf.saxon.value.Value<AtomicValue>
-
- net.sf.saxon.value.AtomicValue
-
- net.sf.saxon.value.NumericValue
-
- net.sf.saxon.value.DecimalValue
-
- All Implemented Interfaces:
java.lang.Comparable
,PullEvent
,GroundedValue<AtomicValue>
,Item<AtomicValue>
,ValueRepresentation<AtomicValue>
,ConversionResult
public final class DecimalValue extends NumericValue
A decimal value
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
DecimalValue.DecimalComparable
A Comparable that performs comparison of a DecimalValue either with another DecimalValue or with some other representation of an XPath numeric value
-
Field Summary
Fields Modifier and Type Field Description static java.math.BigDecimal
BIG_DECIMAL_ONE
static java.math.BigDecimal
BIG_DECIMAL_ONE_MILLION
static java.math.BigInteger
BIG_INTEGER_TEN
static int
DIVIDE_PRECISION
static DecimalValue
ONE
static DecimalValue
ONE_POINT_ONE
static DecimalValue
THREE
static DecimalValue
TWO
static DecimalValue
TWO_POINT_ONE
static DecimalValue
ZERO
-
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Fields inherited from class net.sf.saxon.value.Value
INDETERMINATE_ORDERING
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description DecimalValue(double in)
Constructor supplying a doubleDecimalValue(long in)
Constructor supplying a long integerDecimalValue(java.math.BigDecimal value)
Constructor supplying a BigDecimal
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description NumericValue
abs()
Get the absolute value as defined by the XPath abs() functionstatic boolean
castableAsDecimal(java.lang.CharSequence in)
Test whether a string is castable to a decimal valueNumericValue
ceiling()
Implement the XPath ceiling() functionint
compareTo(long other)
Compare the value to a longint
compareTo(java.lang.Object other)
Compare the value to another numeric valueAtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a difNferent type labelstatic FastStringBuffer
decimalToString(java.math.BigDecimal value, FastStringBuffer fsb)
Convert a decimal value to a string, using the XPath rules for formattingboolean
effectiveBooleanValue()
Get the effective boolean value of the valueNumericValue
floor()
Implement the XPath floor() functionjava.lang.CharSequence
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.java.math.BigDecimal
getDecimalValue()
Get the valuedouble
getDoubleValue()
Get the numeric value as a doublefloat
getFloatValue()
Get the numeric value converted to a floatjava.lang.CharSequence
getPrimitiveStringValue()
Get the value as a StringBuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.java.lang.Comparable
getSchemaComparable()
Get an object that implements XML Schema comparison semanticsint
hashCode()
Get the hashCode.boolean
isIdentical(Value v)
Determine whether two atomic values are identical, as determined by XML Schema rules.boolean
isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integerlong
longValue()
Return the numeric value as a Java long.static ConversionResult
makeDecimalValue(java.lang.CharSequence in, boolean validate)
Factory method to construct a DecimalValue from a stringNumericValue
negate()
Negate the valueNumericValue
round(int scale)
Implement the XPath round() functionNumericValue
roundHalfToEven(int scale)
Implement the XPath round-half-to-even() functionint
signum()
Determine whether the value is negative, zero, or positive-
Methods inherited from class net.sf.saxon.value.NumericValue
equals, getXPathComparable, isInteger, parseNumber, toString
-
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, getCardinality, getComponent, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence
-
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, getSequenceLength, reduce
-
-
-
-
Field Detail
-
DIVIDE_PRECISION
public static final int DIVIDE_PRECISION
- See Also:
- Constant Field Values
-
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
-
ZERO
public static final DecimalValue ZERO
-
ONE
public static final DecimalValue ONE
-
ONE_POINT_ONE
public static final DecimalValue ONE_POINT_ONE
-
TWO
public static final DecimalValue TWO
-
TWO_POINT_ONE
public static final DecimalValue TWO_POINT_ONE
-
THREE
public static final DecimalValue THREE
-
-
Constructor Detail
-
DecimalValue
public DecimalValue(java.math.BigDecimal value)
Constructor supplying a BigDecimal- Parameters:
value
- the value of the DecimalValue
-
DecimalValue
public DecimalValue(double in) throws ValidationException
Constructor supplying a double- Parameters:
in
- the value of the DecimalValue- Throws:
ValidationException
-
DecimalValue
public DecimalValue(long in)
Constructor supplying a long integer- Parameters:
in
- the value of the DecimalValue
-
-
Method Detail
-
makeDecimalValue
public static ConversionResult makeDecimalValue(java.lang.CharSequence in, boolean validate)
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.
-
castableAsDecimal
public static boolean castableAsDecimal(java.lang.CharSequence in)
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
public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a difNferent type label- Specified by:
copyAsSubType
in 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
public BuiltInAtomicType 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:
getPrimitiveType
in classAtomicValue
- Returns:
- the primitive type
-
getDoubleValue
public double getDoubleValue()
Get the numeric value as a double- Specified by:
getDoubleValue
in 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:
getFloatValue
in classNumericValue
- Returns:
- a float representing this numeric value; NaN if it cannot be converted
-
longValue
public long longValue() throws XPathException
Return the numeric value as a Java long.- Specified by:
longValue
in classNumericValue
- Returns:
- the numeric value as a Java long. This performs truncation towards zero.
- Throws:
XPathException
- if the value cannot be converted
-
getDecimalValue
public java.math.BigDecimal getDecimalValue()
Get the value- Specified by:
getDecimalValue
in 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:
hashCode
in classNumericValue
- Returns:
- the hash code of the numeric value
- See Also:
NumericValue.hashCode()
-
effectiveBooleanValue
public boolean effectiveBooleanValue()
Description copied from class:AtomicValue
Get the effective boolean value of the value- Overrides:
effectiveBooleanValue
in classAtomicValue
- Returns:
- true, unless the value is boolean false, numeric zero, or zero-length string
-
getCanonicalLexicalRepresentation
public java.lang.CharSequence 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.- Overrides:
getCanonicalLexicalRepresentation
in classValue<AtomicValue>
- 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
public java.lang.CharSequence getPrimitiveStringValue()
Get the value as a String- Specified by:
getPrimitiveStringValue
in classAtomicValue
- Returns:
- a String representation of the value
-
decimalToString
public static FastStringBuffer decimalToString(java.math.BigDecimal value, FastStringBuffer fsb)
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
public NumericValue negate()
Negate the value- Specified by:
negate
in classNumericValue
- 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 classNumericValue
- 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 classNumericValue
- Returns:
- a value, of the same type as that supplied, rounded towards plus infinity
-
round
public NumericValue round(int scale)
Implement the XPath round() function- Specified by:
round
in classNumericValue
- 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 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:
signum
in 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:
isWholeNumber
in classNumericValue
- Returns:
- true if the value is a whole number
-
abs
public NumericValue abs()
Get the absolute value as defined by the XPath abs() function- Specified by:
abs
in classNumericValue
- Returns:
- the absolute value
- Since:
- 9.2
-
compareTo
public int compareTo(java.lang.Object other)
Compare the value to another numeric value- Specified by:
compareTo
in interfacejava.lang.Comparable
- Overrides:
compareTo
in 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:
compareTo
in 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
public java.lang.Comparable getSchemaComparable()
Get an object that implements XML Schema comparison semantics- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-
isIdentical
public boolean isIdentical(Value v)
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:
isIdentical
in classAtomicValue
- Parameters:
v
- the other value to be compared with this one- Returns:
- true if the two values are identical, false otherwise.
-
-