Package net.sf.saxon.value
Class IntegerValue
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.IntegerValue
- All Implemented Interfaces:
Serializable
,Comparable
,Expression
,Item
,ValueRepresentation
An integer value: note this is a subtype of decimal in XML Schema, not a primitive type.
This class also supports the built-in subtypes of xs:integer.
Actually supports a value in the range permitted by a Java "long"
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IntegerValue
IntegerValue representing the maximum value for this classstatic final IntegerValue
IntegerValue representing the minimum value for this classstatic final IntegerValue
IntegerValue representing the value -1static final IntegerValue
IntegerValue representing the value +1static final IntegerValue
IntegerValue representing the value zeroFields 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
ConstructorsConstructorDescriptionIntegerValue
(long value) Constructor supplying a longIntegerValue
(long val, AtomicType type) Constructor for a subtype, supplying an integer -
Method Summary
Modifier and TypeMethodDescriptionarithmetic
(int operator, NumericValue other, XPathContext context) Evaluate a binary arithmetic operator.ceiling()
Implement the XPath ceiling() function(package private) static boolean
checkBigRange
(BigInteger big, AtomicType type) Check that a BigInteger is within the required range for a given integer subtype.(package private) static boolean
checkRange
(long value, AtomicType type) Check that a value is in range for the specified subtype of xs:integerboolean
checkRange
(AtomicType type) This class allows subtypes of xs:integer to be held, as well as xs:integer values.int
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)convertToSubtype
(AtomicType subtype, boolean validate) Convert the value to a subtype of xs:integerboolean
effectiveBooleanValue
(XPathContext context) Return the effective boolean value of this integerfloor()
Implement the XPath floor() functionDetermine the data type of the expressionGet the value as a Stringint
hashCode()
Get the hashCode.boolean
Determine whether the value is a whole number, that is, whether it compares equal to some integerlong
Get the valuenegate()
Negate the valueround()
Implement the XPath round() functionroundHalfToEven
(int scale) Implement the XPath round-to-half-even() functionvoid
setSubType
(AtomicType type) This class allows subtypes of xs:integer to be held, as well as xs:integer values.double
signum()
Determine whether the value is negative, zero, or positivestatic AtomicValue
Static factory method to convert strings to integers.Methods inherited from class net.sf.saxon.value.NumericValue
equals, getDoubleValue, isInteger, isNaN, parseNumber, promote, toString
Methods inherited from class net.sf.saxon.value.AtomicValue
checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getStringValueCS, 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
-
MINUS_ONE
IntegerValue representing the value -1 -
ZERO
IntegerValue representing the value zero -
PLUS_ONE
IntegerValue representing the value +1 -
MAX_LONG
IntegerValue representing the maximum value for this class -
MIN_LONG
IntegerValue representing the minimum value for this class
-
-
Constructor Details
-
IntegerValue
public IntegerValue(long value) Constructor supplying a long- Parameters:
value
- the value of the IntegerValue
-
IntegerValue
Constructor for a subtype, supplying an integer- Parameters:
val
- The supplied value, as an integertype
- the required item type, a subtype of xs:integer- Throws:
DynamicError
- if the supplied value is out of range for the target type
-
-
Method Details
-
convertToSubtype
Convert the value to a subtype of xs:integer- Parameters:
subtype
- the target subtypevalidate
- true if validation is required; false if the caller already knows that the value is valid- Returns:
- null if the conversion succeeds; a ValidationException describing the failure if it fails. Note that the exception is returned, not thrown.
-
setSubType
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method sets the required type label. It is the caller's responsibility to check that the value is within range. -
checkRange
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method checks that the value is within range, and also sets the type label.- Parameters:
type
- the subtype of integer required- Returns:
- true if successful, false if value is out of range for the subtype
-
stringToInteger
Static factory method to convert strings to integers.- Parameters:
s
- CharSequence representing the string to be converted- Returns:
- either an IntegerValue or a BigIntegerValue representing the value of the String, or an ErrorValue encapsulating an Exception if the value cannot be converted.
-
checkRange
Check that a value is in range for the specified subtype of xs:integer- Parameters:
value
- the value to be checkedtype
- the required item type, a subtype of xs:integer- Returns:
- true if successful, false if value is out of range for the subtype
-
checkBigRange
Check that a BigInteger is within the required range for a given integer subtype. This method is expensive, so it should not be used unless the BigInteger is outside the range of a long. -
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:
-
longValue
public long longValue()Get the value- Overrides:
longValue
in classNumericValue
- Returns:
- the value of the xs:integer, as a Java long
-
effectiveBooleanValue
Return the effective boolean value of this integer- Specified by:
effectiveBooleanValue
in interfaceExpression
- Overrides:
effectiveBooleanValue
in classAtomicValue
- Parameters:
context
- The dynamic evaluation context; ignored in this implementation of the method- Returns:
- false if the integer is zero, otherwise true
-
compareTo
Compare the value to another numeric value- Specified by:
compareTo
in interfaceComparable
- Overrides:
compareTo
in classNumericValue
- 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
-
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
-
convertPrimitive
public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- an integer identifying 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
-- Returns:
- an AtomicValue, a value of the required type
-
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:
-
negate
Negate the value- Specified by:
negate
in classNumericValue
- Returns:
- the result of inverting the sign of the value
-
floor
Implement the XPath floor() function- Specified by:
floor
in classNumericValue
- Returns:
- the integer value, unchanged
-
ceiling
Implement the XPath ceiling() function- Specified by:
ceiling
in classNumericValue
- Returns:
- the integer value, unchanged
-
round
Implement the XPath round() function- Specified by:
round
in classNumericValue
- Returns:
- the integer value, unchanged
-
roundHalfToEven
Implement the XPath round-to-half-even() function- Specified by:
roundHalfToEven
in classNumericValue
- 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
-
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:
- always true for this implementation
-
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 operator to be applied, identified by a constant in the Tokenizer classother
- 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- See Also:
-
getItemType
Determine the data type of the expression- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classValue
- Parameters:
th
-- Returns:
- the actual data type
-
convertToJava
Convert to Java object (for passing to external functions)- Overrides:
convertToJava
in classValue
- 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
-