net.sf.saxon.value

Class DecimalValue

public final class DecimalValue extends NumericValue

A decimal value

Nested Class Summary
protected static class	DecimalValue.DecimalComparable

Field Summary
static BigDecimal	BIG_DECIMAL_ONE
static BigDecimal	BIG_DECIMAL_ONE_MILLION
static BigInteger	BIG_INTEGER_TEN
static int	DIVIDE_PRECISION
static DecimalValue	ONE
static DecimalValue	ZERO

Constructor Summary
	DecimalValue(BigDecimal value) Constructor supplying a BigDecimal
	DecimalValue(double in) Constructor supplying a double
	DecimalValue(long in) Constructor supplying a long integer

Method Summary
NumericValue	abs() Get the absolute value as defined by the XPath abs() function
static boolean	castableAsDecimal(CharSequence in) Test whether a string is castable to a decimal value
NumericValue	ceiling() Implement the XPath ceiling() function
int	compareTo(Object other) Compare the value to another numeric value
int	compareTo(long other) Compare the value to a long
ConversionResult	convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type
AtomicValue	copyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type label
static FastStringBuffer	decimalToString(BigDecimal value, FastStringBuffer fsb) Convert a decimal value to a string, using the XPath rules for formatting
boolean	effectiveBooleanValue()
NumericValue	floor() Implement the XPath floor() function
CharSequence	getCanonicalLexicalRepresentation() Get the canonical lexical representation as defined in XML Schema.
BigDecimal	getDecimalValue() Get the value
CharSequence	getPrimitiveStringValue() Get the value as a String
BuiltInAtomicType	getPrimitiveType() Determine the primitive type of the value.
Comparable	getSchemaComparable() Get an object that implements XML Schema comparison semantics
int	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 integer
static ConversionResult	makeDecimalValue(CharSequence in, boolean validate) Factory method to construct a DecimalValue from a string
NumericValue	negate() Negate the value
NumericValue	round() Implement the XPath round() function
NumericValue	roundHalfToEven(int scale) Implement the XPath round-half-to-even() function
double	signum() Determine whether the value is negative, zero, or positive

Field Detail

BIG_DECIMAL_ONE

public static final BigDecimal BIG_DECIMAL_ONE

BIG_DECIMAL_ONE_MILLION

public static final BigDecimal BIG_DECIMAL_ONE_MILLION

BIG_INTEGER_TEN

public static final BigInteger BIG_INTEGER_TEN

DIVIDE_PRECISION

public static final int DIVIDE_PRECISION

Constructor Detail

DecimalValue

public DecimalValue(BigDecimal value)

Constructor supplying a BigDecimal

Parameters: value the value of the DecimalValue

DecimalValue

public DecimalValue(double in)

Constructor supplying a double

Parameters: in the value of the DecimalValue

DecimalValue

public DecimalValue(long in)

Constructor supplying a long integer

Parameters: in the value of the DecimalValue

Method Detail

abs

public NumericValue abs()

Get the absolute value as defined by the XPath abs() function

Returns: the absolute value

Since: 9.2

castableAsDecimal

public static boolean castableAsDecimal(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

ceiling

public NumericValue ceiling()

Implement the XPath ceiling() function

compareTo

public int compareTo(Object other)

Compare the value to another numeric value

compareTo

public int compareTo(long other)

Compare the value to a long

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

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)

Create a copy of this atomic value, with a different type label

Parameters: typeLabel the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

decimalToString

public static FastStringBuffer decimalToString(BigDecimal value, FastStringBuffer fsb)

Convert a decimal value to a string, using the XPath rules for formatting

Parameters: value the decimal value to be converted fsb the FastStringBuffer to which the value is to be appended

Returns: the supplied FastStringBuffer, suitably populated

floor

public NumericValue floor()

Implement the XPath floor() function

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:decimal, the canonical representation always contains a decimal point.

getDecimalValue

public BigDecimal getDecimalValue()

Get the value

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()

Get the value as a String

Returns: a String representation of the 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.

getSchemaComparable

public Comparable getSchemaComparable()

Get an object that implements XML Schema comparison semantics

hashCode

public int hashCode()

Get the hashCode. This must conform to the rules for other NumericValue hashcodes

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.

Parameters: v the other value to be compared with this one

Returns: true if the two values are identical, false otherwise.

isWholeNumber

public boolean isWholeNumber()

Determine whether the value is a whole number, that is, whether it compares equal to some integer

makeDecimalValue

public static ConversionResult makeDecimalValue(CharSequence in, boolean validate)

Factory method to construct a DecimalValue from a string

Parameters: in the value of the DecimalValue validate 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.

Returns: -1 if negative, 0 if zero, +1 if positive, NaN if NaN