net.sf.saxon.value

Class BigIntegerValue

public final class BigIntegerValue extends NumericValue

An integer value: note this is a subtype of decimal in XML Schema, not a primitive type. The class IntegerValue is used to represent xs:integer values that fit comfortably in a Java long; this class is used to represent xs:integer values outside this range, including the built-in subtype xs:unsignedLong
Field Summary
static BigIntegerMAX_UNSIGNED_LONG
static BigIntegerValueZERO
Constructor Summary
BigIntegerValue(BigInteger value)
BigIntegerValue(long value)
Method Summary
NumericValuearithmetic(int operator, NumericValue other, XPathContext context)
Evaluate a binary arithmetic operator.
BigDecimalasDecimal()
NumericValueceiling()
Implement the XPath ceiling() function
intcompareTo(Object other)
Compare the value to another numeric value
AtomicValueconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
ObjectconvertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
ValidationExceptionconvertToSubType(AtomicType type, boolean validate)
This class allows subtypes of xs:integer to be held, as well as xs:integer values.
booleaneffectiveBooleanValue(XPathContext context)
Return the effective boolean value of this integer
NumericValuefloor()
Implement the XPath floor() function
BigIntegergetBigInteger()
Get the value as a BigInteger
ItemTypegetItemType(TypeHierarchy th)
Determine the data type of the expression
StringgetStringValue()
Get the value as a String
inthashCode()
Get the hashCode.
booleanisWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integer
booleanisWithinLongRange()
longlongValue()
Get the value as a long
static NumericValuemakeValue(BigInteger value)
Factory method: makes either an IntegerValue or a BigIntegerValue depending on the value supplied
NumericValuenegate()
Negate the value
NumericValueround()
Implement the XPath round() function
NumericValueroundToHalfEven(int scale)
Implement the XPath round-to-half-even() function
booleanschemaEquals(Value obj)
Compare two values for equality.
doublesignum()
Determine whether the value is negative, zero, or positive

Field Detail

MAX_UNSIGNED_LONG

public static final BigInteger MAX_UNSIGNED_LONG

ZERO

public static final BigIntegerValue ZERO

Constructor Detail

BigIntegerValue

public BigIntegerValue(BigInteger value)

BigIntegerValue

public BigIntegerValue(long value)

Method Detail

arithmetic

public NumericValue arithmetic(int operator, NumericValue other, XPathContext context)
Evaluate a binary arithmetic operator.

Parameters: operator the operator to be applied, identified by a constant in the Tokenizer class other the other operand of the arithmetic expression

Returns: the result of performing the arithmetic operation

Throws: XPathException if an arithmetic failure occurs, e.g. divide by zero

asDecimal

public BigDecimal asDecimal()

ceiling

public NumericValue ceiling()
Implement the XPath ceiling() function

Returns: the integer value, unchanged

compareTo

public int compareTo(Object other)
Compare the value to another numeric value

Parameters: other the numeric value to be compared to this value

Returns: -1 if this value is less than the other, 0 if they are equal, +1 if this value is greater

convertPrimitive

public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type

Parameters: requiredType an integer identifying the required atomic type context

Returns: an AtomicValue, a value of the required type; or an ErrorValue

convertToJava

public Object convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)

Parameters: target The Java class to which conversion is required

Returns: the Java object that results from the conversion; always an instance of the target class

Throws: XPathException if conversion is not possible, or fails

convertToSubType

public ValidationException convertToSubType(AtomicType type, boolean validate)
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method sets the required type label. This method should only be used for values that

Parameters: type the subtype of integer required

Returns: null if the operation succeeds, or a ValidationException if the value is out of range

effectiveBooleanValue

public boolean effectiveBooleanValue(XPathContext context)
Return the effective boolean value of this integer

Parameters: context The dynamic evaluation context; ignored in this implementation of the method

Returns: false if the integer is zero, otherwise true

floor

public NumericValue floor()
Implement the XPath floor() function

Returns: the integer value, unchanged

getBigInteger

public BigInteger getBigInteger()
Get the value as a BigInteger

Returns: teh value of the xs:integer as a Java BigInteger

getItemType

public ItemType getItemType(TypeHierarchy th)
Determine the data type of the expression

Parameters: th

Returns: the actual data type

getStringValue

public String getStringValue()
Get the value as a String

Returns: a String representation of the value

hashCode

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

See Also: NumericValue

isWholeNumber

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

Returns: always true for this implementation

isWithinLongRange

public boolean isWithinLongRange()

longValue

public long longValue()
Get the value as a long

Returns: the value of the xs:integer, as a Java long

makeValue

public static NumericValue makeValue(BigInteger value)
Factory method: makes either an IntegerValue or a BigIntegerValue depending on the value supplied

negate

public NumericValue negate()
Negate the value

Returns: the result of inverting the sign of the value

round

public NumericValue round()
Implement the XPath round() function

Returns: the integer value, unchanged

roundToHalfEven

public NumericValue roundToHalfEven(int scale)
Implement the XPath round-to-half-even() function

Parameters: scale number of digits required after the decimal point; the value -2 (for example) means round to a multiple of 100

Returns: if the scale is >=0, return this value unchanged. Otherwise round it to a multiple of 10**-scale

schemaEquals

public boolean schemaEquals(Value obj)
Compare two values for equality. This supports identity constraints in XML Schema, which allow list-valued elements and attributes to participate in key and uniqueness constraints. This method returns false if any error occurs during the comparison, or if any of the items in either sequence is a node rather than an atomic value. The default implementation of schemaEquals() is the same as equals(), but subclasses can override this.

signum

public double signum()
Determine whether the value is negative, zero, or positive

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