net.sf.saxon.value

Class DoubleValue

Implemented Interfaces:
Comparable, ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, ValueRepresentation

public final class DoubleValue
extends NumericValue

A numeric (double precision floating point) value

Field Summary

static DoubleValue
NEGATIVE_ZERO
static DoubleValue
NaN
static DoubleValue
ONE
static DoubleValue
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

DoubleValue(CharSequence val)
Constructor supplying a string
DoubleValue(double value)
Constructor supplying a double
DoubleValue(double value, AtomicType type)
Constructor supplying a double and an AtomicType, for creating a value that belongs to a user-defined subtype of xs:double.

Method Summary

NumericValue
ceiling()
Implement the XPath ceiling() function
int
compareTo(long other)
Compare the value to a long.
ConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
AtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
static CharSequence
doubleToString(double value)
Internal method used for conversion of a double to a string
boolean
effectiveBooleanValue()
Get the effective boolean value
NumericValue
floor()
Implement the XPath floor() function
CharSequence
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
double
getDoubleValue()
Return this numeric value as a double
BuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.
Comparable
getSchemaComparable()
Get an object that implements XML Schema comparison semantics
String
getStringValue()
Convert the double to a string according to the XPath 2.0 rules
CharSequence
getStringValueCS()
Convert the double to a string according to the XPath 2.0 rules
int
hashCode()
Get the hashCode.
boolean
isNaN()
Test whether the value is the double/float value NaN
boolean
isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integer
NumericValue
negate()
Negate the value
static void
printInternalForm(double d)
Diagnostic method: print the sign, exponent, and significand
NumericValue
round()
Implement the XPath round() function
NumericValue
roundHalfToEven(int scale)
Implement the XPath round-to-half-even() function
double
signum()
Determine whether the value is negative, zero, or positive

Methods inherited from class net.sf.saxon.value.NumericValue

ceiling, compareTo, compareTo, equals, floor, getDecimalValue, getDoubleValue, getFloatValue, getXPathComparable, hashCode, isInteger, isWholeNumber, longValue, negate, parseNumber, promote, round, roundHalfToEven, signum, toString

Methods inherited from class net.sf.saxon.value.AtomicValue

asAtomic, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

Methods inherited from class net.sf.saxon.value.Value

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Field Details

NEGATIVE_ZERO

public static final DoubleValue NEGATIVE_ZERO

NaN

public static final DoubleValue NaN

ONE

public static final DoubleValue ONE

ZERO

public static final DoubleValue ZERO

Constructor Details

DoubleValue

public DoubleValue(CharSequence val)
            throws ValidationException
Constructor supplying a string
Parameters:
val - the string representation of the double value, conforming to the XML Schema lexical representation of xs:double, with leading and trailing spaces permitted
Throws:
ValidationException - if the string does not have the correct lexical form for a double. Note that the error will contain no error code or context information.

DoubleValue

public DoubleValue(double value)
Constructor supplying a double
Parameters:
value - the value of the NumericValue

DoubleValue

public DoubleValue(double value,
                   AtomicType type)
Constructor supplying a double and an AtomicType, for creating a value that belongs to a user-defined subtype of xs:double. It is the caller's responsibility to ensure that the supplied value conforms to the supplied type.
Parameters:
value - the value of the NumericValue
type - the type of the value. This must be a subtype of xs:double, and the value must conform to this type. The methosd does not check these conditions.

Method Details

ceiling

public NumericValue ceiling()
Implement the XPath ceiling() function
Overrides:
ceiling in interface NumericValue

compareTo

public int compareTo(long other)
Compare the value to a long.
Overrides:
compareTo in interface 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

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
Convert to target data type
Overrides:
convertPrimitive in interface AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
validate - true if the supplied value must be validated, false if the caller warrants that it is valid
context - the XPath dynamic context
Returns:
an AtomicValue, a value of the required type

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface Value

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
Overrides:
copyAsSubType in interface AtomicValue
Parameters:
typeLabel - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

doubleToString

public static CharSequence doubleToString(double value)
Internal method used for conversion of a double to a string
Parameters:
value - the actual value
Returns:
the value converted to a string, according to the XPath casting rules.

effectiveBooleanValue

public boolean effectiveBooleanValue()
Get the effective boolean value
Overrides:
effectiveBooleanValue in interface AtomicValue
Returns:
the effective boolean value (true unless the value is zero or NaN)

floor

public NumericValue floor()
Implement the XPath floor() function
Overrides:
floor in interface NumericValue

getCanonicalLexicalRepresentation

public 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:double, the canonical representation always uses exponential notation.
Overrides:
getCanonicalLexicalRepresentation in interface Value

getDoubleValue

public double getDoubleValue()
Return this numeric value as a double
Overrides:
getDoubleValue in interface NumericValue
Returns:
the value as a double

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.
Overrides:
getPrimitiveType in interface AtomicValue

getSchemaComparable

public Comparable getSchemaComparable()
Get an object that implements XML Schema comparison semantics
Overrides:
getSchemaComparable in interface AtomicValue

getStringValue

public String getStringValue()
Convert the double to a string according to the XPath 2.0 rules
Specified by:
getStringValue in interface Item
getStringValue in interface ValueRepresentation
Overrides:
getStringValue in interface AtomicValue
Returns:
the string value

getStringValueCS

public CharSequence getStringValueCS()
Convert the double to a string according to the XPath 2.0 rules
Specified by:
getStringValueCS in interface Item
getStringValueCS in interface ValueRepresentation
Overrides:
getStringValueCS in interface AtomicValue
Returns:
the string value

hashCode

public int hashCode()
Get the hashCode. This must conform to the rules for other NumericValue hashcodes
Overrides:
hashCode in interface NumericValue

isNaN

public boolean isNaN()
Test whether the value is the double/float value NaN
Overrides:
isNaN in interface AtomicValue

isWholeNumber

public boolean isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integer
Overrides:
isWholeNumber in interface NumericValue

negate

public NumericValue negate()
Negate the value
Overrides:
negate in interface NumericValue

printInternalForm

public static void printInternalForm(double d)
Diagnostic method: print the sign, exponent, and significand
Parameters:
d - the double to be diagnosed

round

public NumericValue round()
Implement the XPath round() function
Overrides:
round in interface NumericValue

roundHalfToEven

public NumericValue roundHalfToEven(int scale)
Implement the XPath round-to-half-even() function
Overrides:
roundHalfToEven in interface NumericValue

signum

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