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:

java.lang.Comparable, Expression, Item, java.io.Serializable

public final class IntegerValue

extends NumericValue

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:

Serialized Form

Field Summary
static IntegerValue	MAX_LONG           IntegerValue representing the maximum value for this class
static IntegerValue	MIN_LONG           IntegerValue representing the minimum value for this class
static IntegerValue	MINUS_ONE           IntegerValue representing the value -1
static IntegerValue	PLUS_ONE           IntegerValue representing the value +1
static IntegerValue	ZERO           IntegerValue representing the value zero

 

Constructor Summary

IntegerValue(long value)           Constructor supplying a double

IntegerValue(long val, ItemType type)           Constructor for a subtype, supplying an integer

 

Method Summary
NumericValue	arithmetic(int operator, NumericValue other)           Evaluate a binary arithmetic operator.
long	asLong()           Return the numeric value as a Java long.
NumericValue	ceiling()           Implement the XPath ceiling() function
int	compareTo(java.lang.Object other)           Compare the value to another numeric value
int	conversionPreference(java.lang.Class required, Configuration config)           Get conversion preference for this value to a Java class.
AtomicValue	convert(int requiredType)           Convert to target data type
java.lang.Object	convertToJava(java.lang.Class target, Configuration config)           Convert to Java object (for passing to external functions)
void	display(int level, NamePool pool)           Diagnostic print of expression structure
boolean	effectiveBooleanValue(XPathContext context)           Return the effective boolean value of this integer
NumericValue	floor()           Implement the XPath floor() function
ItemType	getItemType()           Determine the data type of the expression
java.lang.String	getStringValue()           Get the value as a String
long	getValue()           Get the value
int	hashCode()           Get the hashCode.
boolean	isWholeNumber()           Determine whether the value is a whole number, that is, whether it compares equal to some integer
NumericValue	negate()           Negate the value
NumericValue	round()           Implement the XPath round() function
NumericValue	roundToHalfEven(int scale)           Implement the XPath round-to-half-even() function
void	setSubType(ItemType type)
static NumericValue	stringToInteger(java.lang.CharSequence s)           Static method to convert strings to integers.

 

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

asDouble, equals, isInteger, isNaN, promote, toString

 

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

convert, evaluateAsString, evaluateItem, getCardinality, getComponent, getPrimitiveValue, getTypedValue, iterate

 

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

analyze, asItem, asValue, collapseWhitespace, getDependencies, getSpecialProperties, getSubExpressions, inverse, normalizeWhitespace, promote, simplify, stringToNumber, trimWhitespace

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

MINUS_ONE

public static final IntegerValue MINUS_ONE

IntegerValue representing the value -1

ZERO

public static final IntegerValue ZERO

IntegerValue representing the value zero

PLUS_ONE

public static final IntegerValue PLUS_ONE

IntegerValue representing the value +1

MAX_LONG

public static final IntegerValue MAX_LONG

IntegerValue representing the maximum value for this class

MIN_LONG

public static final IntegerValue MIN_LONG

IntegerValue representing the minimum value for this class

IntegerValue

public IntegerValue(long value)

Constructor supplying a double

Parameters:

value - the value of the IntegerValue

IntegerValue

public IntegerValue(long val,
                    ItemType type)
             throws XPathException

Constructor for a subtype, supplying an integer

Parameters:

val - The supplied value, as an integer

type - the required item type, a subtype of xs:integer

Throws:

XPathException - if the supplied value is out of range for the target type

setSubType

public void setSubType(ItemType type)
                throws XPathException

XPathException

stringToInteger

public static NumericValue stringToInteger(java.lang.CharSequence s)
                                    throws XPathException

Static method to convert strings to integers.

Parameters:

s - the String to be converted

Returns:

either an IntegerValue or a BigIntegerValue representing the value of the String; if it cannot be converted, throw an exception

XPathException

hashCode

public int hashCode()

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

Specified by:

hashCode in class NumericValue

Returns:

the hash code of the numeric value

See Also:

NumericValue.hashCode()

getValue

public long getValue()

Get the value

Returns:

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

asLong

public long asLong()

Description copied from class: NumericValue

Return the numeric value as a Java long.

Overrides:

asLong in class NumericValue

Returns:

the numeric value as a Java long. This performs truncation towards zero.

effectiveBooleanValue

public boolean effectiveBooleanValue(XPathContext context)

Return the effective boolean value of this integer

Specified by:

effectiveBooleanValue in interface Expression

Overrides:

effectiveBooleanValue in class AtomicValue

Parameters:

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

Returns:

false if the integer is zero, otherwise true

compareTo

public int compareTo(java.lang.Object other)

Compare the value to another numeric value

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class NumericValue

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

convert

public AtomicValue convert(int requiredType)
                    throws XPathException

Convert to target data type

Specified by:

convert in class AtomicValue

Parameters:

requiredType - an integer identifying the required atomic type

Returns:

an AtomicValue, a value of the required type

Throws:

XPathException - if the conversion is not possible

getStringValue

public java.lang.String getStringValue()

Get the value as a String

Specified by:

getStringValue in interface Item

Specified by:

getStringValue in class Value

Returns:

a String representation of the value

negate

public NumericValue negate()

Negate the value

Specified by:

negate in class NumericValue

Returns:

the result of inverting the sign of the value

floor

public NumericValue floor()

Implement the XPath floor() function

Specified by:

floor in class NumericValue

Returns:

the integer value, unchanged

ceiling

public NumericValue ceiling()

Implement the XPath ceiling() function

Specified by:

ceiling in class NumericValue

Returns:

the integer value, unchanged

round

public NumericValue round()

Implement the XPath round() function

Specified by:

round in class NumericValue

Returns:

the integer value, unchanged

roundToHalfEven

public NumericValue roundToHalfEven(int scale)

Implement the XPath round-to-half-even() function

Specified by:

roundToHalfEven in class NumericValue

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

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 class NumericValue

Returns:

always true for this implementation

arithmetic

public NumericValue arithmetic(int operator,
                               NumericValue other)
                        throws XPathException

Evaluate a binary arithmetic operator.

Specified by:

arithmetic in class NumericValue

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

See Also:

Tokenizer

getItemType

public ItemType getItemType()

Determine the data type of the expression

Returns:

the actual data type

conversionPreference

public int conversionPreference(java.lang.Class required,
                                Configuration config)

Get conversion preference for this value to a Java class.

Overrides:

conversionPreference in class AtomicValue

Parameters:

required - the Java class to which conversion is required

Returns:

the conversion preference. A low result indicates higher preference.

convertToJava

public java.lang.Object convertToJava(java.lang.Class target,
                                      Configuration config)
                               throws XPathException

Convert to Java object (for passing to external functions)

Overrides:

convertToJava in class AtomicValue

Parameters:

target - The Java class to which conversion is required

config - The configuration (needed for access to schema information)

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

display

public void display(int level,
                    NamePool pool)

Diagnostic print of expression structure

Parameters:

level - indentation level of the output