|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.value.Value<AtomicValue> net.sf.saxon.value.AtomicValue net.sf.saxon.value.NumericValue net.sf.saxon.value.DecimalValue
public final class DecimalValue
A decimal value
Nested Class Summary | |
---|---|
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 | |
---|---|
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 |
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 | |
---|---|
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(long other)
Compare the value to a long |
int |
compareTo(Object other)
Compare the value to another numeric value |
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a difNferent type label |
static FastStringBuffer |
decimalToString(BigDecimal value,
FastStringBuffer fsb)
Convert a decimal value to a string, using the XPath rules for formatting |
boolean |
effectiveBooleanValue()
Get the effective boolean value of the value |
NumericValue |
floor()
Implement the XPath floor() function |
CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. |
BigDecimal |
getDecimalValue()
Get the value |
double |
getDoubleValue()
Get the numeric value as a double |
float |
getFloatValue()
Get the numeric value converted to a float |
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 |
long |
longValue()
Return the numeric value as a Java long. |
static ConversionResult |
makeDecimalValue(CharSequence in,
boolean validate)
Factory method to construct a DecimalValue from a string |
NumericValue |
negate()
Negate the value |
NumericValue |
round(int scale)
Implement the XPath round() function |
NumericValue |
roundHalfToEven(int scale)
Implement the XPath round-half-to-even() function |
int |
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DIVIDE_PRECISION
public static final BigDecimal BIG_DECIMAL_ONE
public static final BigInteger BIG_INTEGER_TEN
public static final BigDecimal BIG_DECIMAL_ONE_MILLION
public static final DecimalValue ZERO
public static final DecimalValue ONE
public static final DecimalValue ONE_POINT_ONE
public static final DecimalValue TWO
public static final DecimalValue TWO_POINT_ONE
public static final DecimalValue THREE
Constructor Detail |
---|
public DecimalValue(BigDecimal value)
value
- the value of the DecimalValuepublic DecimalValue(double in) throws ValidationException
in
- the value of the DecimalValue
ValidationException
public DecimalValue(long in)
in
- the value of the DecimalValueMethod Detail |
---|
public static ConversionResult makeDecimalValue(CharSequence in, boolean validate)
in
- the value of the DecimalValuevalidate
- true if validation is required; false if the caller knows that the value is valid
public static boolean castableAsDecimal(CharSequence in)
in
- the string to be tested
public AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType
in class AtomicValue
typeLabel
- the type label of the new copy. The caller is responsible for checking that
the value actually conforms to this type.
public BuiltInAtomicType getPrimitiveType()
getPrimitiveType
in class AtomicValue
public double getDoubleValue()
getDoubleValue
in class NumericValue
public float getFloatValue()
getFloatValue
in class NumericValue
public long longValue() throws XPathException
longValue
in class NumericValue
XPathException
- if the value cannot be convertedpublic BigDecimal getDecimalValue()
getDecimalValue
in class NumericValue
public int hashCode()
hashCode
in class NumericValue
NumericValue.hashCode()
public boolean effectiveBooleanValue()
AtomicValue
effectiveBooleanValue
in class AtomicValue
public CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in class Value<AtomicValue>
public CharSequence getPrimitiveStringValue()
getPrimitiveStringValue
in class AtomicValue
public static FastStringBuffer decimalToString(BigDecimal value, FastStringBuffer fsb)
value
- the decimal value to be convertedfsb
- the FastStringBuffer to which the value is to be appended
public NumericValue negate()
negate
in class NumericValue
public NumericValue floor()
floor
in class NumericValue
public NumericValue ceiling()
ceiling
in class NumericValue
public NumericValue round(int scale)
round
in class NumericValue
public NumericValue roundHalfToEven(int scale)
roundHalfToEven
in class NumericValue
scale
- the decimal position for rounding: e.g. 2 rounds to a
multiple of 0.01, while -2 rounds to a multiple of 100
public int signum()
signum
in class NumericValue
public boolean isWholeNumber()
isWholeNumber
in class NumericValue
public NumericValue abs()
abs
in class NumericValue
public int compareTo(Object other)
compareTo
in interface Comparable
compareTo
in class NumericValue
other
- The other numeric value
public int compareTo(long other)
compareTo
in class NumericValue
other
- the value to be compared with
public Comparable getSchemaComparable()
getSchemaComparable
in class AtomicValue
public boolean isIdentical(Value v)
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.
isIdentical
in class AtomicValue
v
- the other value to be compared with this one
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |