Package net.sf.saxon.value
Class DecimalValue
- java.lang.Object
-
- net.sf.saxon.value.Value
-
- net.sf.saxon.value.AtomicValue
-
- net.sf.saxon.value.NumericValue
-
- net.sf.saxon.value.DecimalValue
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable
,PullEvent
,SequenceIterable
,GroundedValue
,Item
,ValueRepresentation
,ConversionResult
public final class DecimalValue extends NumericValue
A decimal value- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
DecimalValue.DecimalComparable
-
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
ZERO
-
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY, 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 static 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 valueConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data typeAtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different 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 valueBuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.java.lang.Comparable
getSchemaComparable()
Get an object that implements XML Schema comparison semanticsjava.lang.String
getStringValue()
Get the value as a Stringjava.lang.CharSequence
getStringValueCS()
Get the value of the item as a CharSequence.int
hashCode()
Get the hashCode.boolean
isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integerstatic ConversionResult
makeDecimalValue(java.lang.CharSequence in, boolean validate)
Factory method to construct a DecimalValue from a stringNumericValue
negate()
Negate the valueNumericValue
round()
Implement the XPath round() functionNumericValue
roundHalfToEven(int scale)
Implement the XPath round-half-to-even() functiondouble
signum()
Determine whether the value is negative, zero, or positive-
Methods inherited from class net.sf.saxon.value.NumericValue
equals, getDoubleValue, getFloatValue, getXPathComparable, isInteger, longValue, parseNumber, promote, toString
-
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence
-
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, makeQNameValue, reduce, stringToNumber
-
-
-
-
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
-
-
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 different 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
-
getDecimalValue
public java.math.BigDecimal getDecimalValue()
Get the value- Overrides:
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
-
convertPrimitive
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- the required atomic type. This must either be a primitive type, or a built-in type derived from the same primitive type as this atomic value.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 xs:Name or similar types: it determines the NameChecker to be used.- Returns:
- the result of the conversion, if successful. If unsuccessful, the value returned will be a ValidationFailure. The caller must check for this condition. No exception is thrown, instead the exception information will be encapsulated within the ValidationFailure.
-
getStringValueCS
public java.lang.CharSequence getStringValueCS()
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classAtomicValue
- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
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
- Returns:
- the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
-
getStringValue
public java.lang.String getStringValue()
Get the value as a String- Specified by:
getStringValue
in interfaceItem
- Specified by:
getStringValue
in interfaceValueRepresentation
- Specified by:
getStringValue
in classAtomicValue
- Returns:
- a String representation of the value
- See Also:
Item.getStringValueCS()
-
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()
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 double 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
-
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
-
-