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:
Serializable
,Comparable
,Expression
,Item
,ValueRepresentation
A decimal value
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BigDecimal
static final BigDecimal
static final BigInteger
static final DecimalValue
static final DecimalValue
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionDecimalValue
(double in) Constructor supplying a doubleDecimalValue
(long in) Constructor supplying a long integerDecimalValue
(BigDecimal value) Constructor supplying a BigDecimal -
Method Summary
Modifier and TypeMethodDescriptionarithmetic
(int operator, NumericValue other, XPathContext context) Evaluate a binary arithmetic operator.static boolean
Test whether a string is castable to a decimal valueceiling()
Implement the XPath ceiling() functionint
compareTo
(long other) Compare the value to a longint
Compare the value to another numeric valueconvertPrimitive
(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data typeconvertToJava
(Class target, XPathContext context) Convert to Java object (for passing to external functions)static CharSequence
decimalToString
(BigDecimal value) boolean
effectiveBooleanValue
(XPathContext context) Get the effective boolean value of the valuefloor()
Implement the XPath floor() functionDetermine the data type of the expressionGet the value as a StringGet the value of the item as a CharSequence.getValue()
Get the valueint
hashCode()
Get the hashCode.boolean
Determine whether the value is a whole number, that is, whether it compares equal to some integerstatic AtomicValue
makeDecimalValue
(CharSequence in, boolean validate) Factory method to construct a DecimalValue from a stringnegate()
Negate the valueround()
Implement the XPath round() functionroundHalfToEven
(int scale) Implement the XPath round-half-to-even() functiondouble
signum()
Determine whether the value is negative, zero, or positiveMethods inherited from class net.sf.saxon.value.NumericValue
equals, getDoubleValue, isInteger, isNaN, longValue, parseNumber, promote, toString
Methods inherited from class net.sf.saxon.value.AtomicValue
checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process
Methods inherited from class net.sf.saxon.value.Value
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck
-
Field Details
-
BIG_DECIMAL_ONE
-
BIG_INTEGER_TEN
-
BIG_DECIMAL_ONE_MILLION
-
ZERO
-
ONE
-
-
Constructor Details
-
DecimalValue
Constructor supplying a BigDecimal- Parameters:
value
- the value of the DecimalValue
-
DecimalValue
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 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 an ErrorValue encapsulating the error message if not.
-
castableAsDecimal
Test whether a string is castable to a decimal value -
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 classNumericValue
- Returns:
- the hash code of the numeric value
- See Also:
-
effectiveBooleanValue
Description copied from class:AtomicValue
Get the effective boolean value of the value- Specified by:
effectiveBooleanValue
in interfaceExpression
- Overrides:
effectiveBooleanValue
in classAtomicValue
- 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 classAtomicValue
- Parameters:
requiredType
- type code of the required atomic typevalidate
- 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.
-
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:
-
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:
-
decimalToString
-
getItemType
Determine the data type of the expression- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classValue
- Parameters:
th
-- Returns:
- Type.DECIMAL
-
negate
Negate the value- Specified by:
negate
in classNumericValue
- Returns:
- a value, of the same type as the original, with its sign inverted
-
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
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
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
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
-
arithmetic
public NumericValue arithmetic(int operator, NumericValue other, XPathContext context) throws XPathException Evaluate a binary arithmetic operator.- Specified by:
arithmetic
in classNumericValue
- Parameters:
operator
- the binary arithmetic operation to be performed. Uses the constants defined in the Tokenizer classother
- the other operand- Returns:
- the result of the arithmetic operation
- Throws:
XPathException
- if an arithmetic error occurs- See Also:
-
compareTo
Compare the value to another numeric value- Specified by:
compareTo
in interfaceComparable
- 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.
-
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
-
convertToJava
Convert to Java object (for passing to external functions)- Overrides:
convertToJava
in classValue
- Throws:
XPathException
-