<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:44 GMT 2011 --> <TITLE> DecimalValue </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DecimalValue"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/value/DayTimeDurationValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/value/DecimalValue.DecimalComparable.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/value/DecimalValue.html" target="_top"><B>FRAMES</B></A> <A HREF="DecimalValue.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.saxon.value</FONT> <BR> Class DecimalValue</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">net.sf.saxon.value.Value</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">net.sf.saxon.value.AtomicValue</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">net.sf.saxon.value.NumericValue</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.value.DecimalValue</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>, <A HREF="../../../../net/sf/saxon/evpull/PullEvent.html" title="interface in net.sf.saxon.evpull">PullEvent</A>, <A HREF="../../../../net/sf/saxon/om/GroundedValue.html" title="interface in net.sf.saxon.om">GroundedValue</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>>, <A HREF="../../../../net/sf/saxon/type/ConversionResult.html" title="interface in net.sf.saxon.type">ConversionResult</A></DD> </DL> <HR> <DL> <DT><PRE>public final class <B>DecimalValue</B><DT>extends <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></DL> </PRE> <P> A decimal value <P> <P> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.DecimalComparable.html" title="class in net.sf.saxon.value">DecimalValue.DecimalComparable</A></B></CODE> <BR> A Comparable that performs comparison of a DecimalValue either with another DecimalValue or with some other representation of an XPath numeric value</TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#BIG_DECIMAL_ONE">BIG_DECIMAL_ONE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#BIG_DECIMAL_ONE_MILLION">BIG_DECIMAL_ONE_MILLION</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#BIG_INTEGER_TEN">BIG_INTEGER_TEN</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#DIVIDE_PRECISION">DIVIDE_PRECISION</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#ONE">ONE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#ONE_POINT_ONE">ONE_POINT_ONE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#THREE">THREE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#TWO">TWO</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#TWO_POINT_ONE">TWO_POINT_ONE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#ZERO">ZERO</A></B></CODE> <BR> </TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.value.AtomicValue"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#typeLabel">typeLabel</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.value.Value"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#INDETERMINATE_ORDERING">INDETERMINATE_ORDERING</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#EMPTY_VALUE_ARRAY">EMPTY_VALUE_ARRAY</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#DecimalValue(java.math.BigDecimal)">DecimalValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> value)</CODE> <BR> Constructor supplying a BigDecimal</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#DecimalValue(double)">DecimalValue</A></B>(double in)</CODE> <BR> Constructor supplying a double</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#DecimalValue(long)">DecimalValue</A></B>(long in)</CODE> <BR> Constructor supplying a long integer</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#abs()">abs</A></B>()</CODE> <BR> Get the absolute value as defined by the XPath abs() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#castableAsDecimal(java.lang.CharSequence)">castableAsDecimal</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> in)</CODE> <BR> Test whether a string is castable to a decimal value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#ceiling()">ceiling</A></B>()</CODE> <BR> Implement the XPath ceiling() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#compareTo(long)">compareTo</A></B>(long other)</CODE> <BR> Compare the value to a long</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE> <BR> Compare the value to another numeric value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#copyAsSubType(net.sf.saxon.type.AtomicType)">copyAsSubType</A></B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</CODE> <BR> Create a copy of this atomic value, with a difNferent type label</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#decimalToString(java.math.BigDecimal, net.sf.saxon.tree.util.FastStringBuffer)">decimalToString</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> value, <A HREF="../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A> fsb)</CODE> <BR> Convert a decimal value to a string, using the XPath rules for formatting</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#effectiveBooleanValue()">effectiveBooleanValue</A></B>()</CODE> <BR> Get the effective boolean value of the value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#floor()">floor</A></B>()</CODE> <BR> Implement the XPath floor() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getCanonicalLexicalRepresentation()">getCanonicalLexicalRepresentation</A></B>()</CODE> <BR> Get the canonical lexical representation as defined in XML Schema.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getDecimalValue()">getDecimalValue</A></B>()</CODE> <BR> Get the value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getDoubleValue()">getDoubleValue</A></B>()</CODE> <BR> Get the numeric value as a double</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> float</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getFloatValue()">getFloatValue</A></B>()</CODE> <BR> Get the numeric value converted to a float</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getPrimitiveStringValue()">getPrimitiveStringValue</A></B>()</CODE> <BR> Get the value as a String</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/type/BuiltInAtomicType.html" title="class in net.sf.saxon.type">BuiltInAtomicType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getPrimitiveType()">getPrimitiveType</A></B>()</CODE> <BR> Determine the primitive type of the value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#getSchemaComparable()">getSchemaComparable</A></B>()</CODE> <BR> Get an object that implements XML Schema comparison semantics</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#hashCode()">hashCode</A></B>()</CODE> <BR> Get the hashCode.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#isIdentical(net.sf.saxon.value.Value)">isIdentical</A></B>(<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> v)</CODE> <BR> Determine whether two atomic values are identical, as determined by XML Schema rules.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#isWholeNumber()">isWholeNumber</A></B>()</CODE> <BR> Determine whether the value is a whole number, that is, whether it compares equal to some integer</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#longValue()">longValue</A></B>()</CODE> <BR> Return the numeric value as a Java long.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/type/ConversionResult.html" title="interface in net.sf.saxon.type">ConversionResult</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#makeDecimalValue(java.lang.CharSequence, boolean)">makeDecimalValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> in, boolean validate)</CODE> <BR> Factory method to construct a DecimalValue from a string</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#negate()">negate</A></B>()</CODE> <BR> Negate the value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#round(int)">round</A></B>(int scale)</CODE> <BR> Implement the XPath round() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#roundHalfToEven(int)">roundHalfToEven</A></B>(int scale)</CODE> <BR> Implement the XPath round-half-to-even() function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/DecimalValue.html#signum()">signum</A></B>()</CODE> <BR> Determine whether the value is negative, zero, or positive</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.value.NumericValue"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html#getXPathComparable(boolean, net.sf.saxon.lib.StringCollator, net.sf.saxon.expr.XPathContext)">getXPathComparable</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html#isInteger(net.sf.saxon.value.AtomicValue)">isInteger</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html#parseNumber(java.lang.String)">parseNumber</A>, <A HREF="../../../../net/sf/saxon/value/NumericValue.html#toString()">toString</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.value.AtomicValue"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#asAtomic()">asAtomic</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#checkPermittedContents(net.sf.saxon.type.SchemaType, net.sf.saxon.expr.StaticContext, boolean)">checkPermittedContents</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getCardinality()">getCardinality</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getComponent(int)">getComponent</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getItemType(net.sf.saxon.type.TypeHierarchy)">getItemType</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getLength()">getLength</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getStringValueCS()">getStringValueCS</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getTypedValue()">getTypedValue</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getTypeLabel()">getTypeLabel</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#isNaN()">isNaN</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#itemAt(int)">itemAt</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#iterate()">iterate</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#process(net.sf.saxon.expr.XPathContext)">process</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#setTypeLabel(net.sf.saxon.type.AtomicType)">setTypeLabel</A>, <A HREF="../../../../net/sf/saxon/value/AtomicValue.html#subsequence(int, int)">subsequence</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.value.Value"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#asItem()">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asItem(net.sf.saxon.om.ValueRepresentation)">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asIterator(net.sf.saxon.om.ValueRepresentation)">asIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asValue(net.sf.saxon.om.ValueRepresentation)">asValue</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#convertToJava(net.sf.saxon.om.Item)">convertToJava</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#fromItem(net.sf.saxon.om.Item)">fromItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getIterator(net.sf.saxon.om.ValueRepresentation)">getIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getSequenceLength(net.sf.saxon.om.ValueRepresentation)">getSequenceLength</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#reduce()">reduce</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DIVIDE_PRECISION"><!-- --></A><H3> DIVIDE_PRECISION</H3> <PRE> public static final int <B>DIVIDE_PRECISION</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.value.DecimalValue.DIVIDE_PRECISION">Constant Field Values</A></DL> </DL> <HR> <A NAME="BIG_DECIMAL_ONE"><!-- --></A><H3> BIG_DECIMAL_ONE</H3> <PRE> public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> <B>BIG_DECIMAL_ONE</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="BIG_INTEGER_TEN"><!-- --></A><H3> BIG_INTEGER_TEN</H3> <PRE> public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</A> <B>BIG_INTEGER_TEN</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="BIG_DECIMAL_ONE_MILLION"><!-- --></A><H3> BIG_DECIMAL_ONE_MILLION</H3> <PRE> public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> <B>BIG_DECIMAL_ONE_MILLION</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="ZERO"><!-- --></A><H3> ZERO</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>ZERO</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="ONE"><!-- --></A><H3> ONE</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>ONE</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="ONE_POINT_ONE"><!-- --></A><H3> ONE_POINT_ONE</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>ONE_POINT_ONE</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="TWO"><!-- --></A><H3> TWO</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>TWO</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="TWO_POINT_ONE"><!-- --></A><H3> TWO_POINT_ONE</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>TWO_POINT_ONE</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="THREE"><!-- --></A><H3> THREE</H3> <PRE> public static final <A HREF="../../../../net/sf/saxon/value/DecimalValue.html" title="class in net.sf.saxon.value">DecimalValue</A> <B>THREE</B></PRE> <DL> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DecimalValue(java.math.BigDecimal)"><!-- --></A><H3> DecimalValue</H3> <PRE> public <B>DecimalValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> value)</PRE> <DL> <DD>Constructor supplying a BigDecimal <P> <DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of the DecimalValue</DL> </DL> <HR> <A NAME="DecimalValue(double)"><!-- --></A><H3> DecimalValue</H3> <PRE> public <B>DecimalValue</B>(double in) throws <A HREF="../../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></PRE> <DL> <DD>Constructor supplying a double <P> <DL> <DT><B>Parameters:</B><DD><CODE>in</CODE> - the value of the DecimalValue <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></CODE></DL> </DL> <HR> <A NAME="DecimalValue(long)"><!-- --></A><H3> DecimalValue</H3> <PRE> public <B>DecimalValue</B>(long in)</PRE> <DL> <DD>Constructor supplying a long integer <P> <DL> <DT><B>Parameters:</B><DD><CODE>in</CODE> - the value of the DecimalValue</DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="makeDecimalValue(java.lang.CharSequence, boolean)"><!-- --></A><H3> makeDecimalValue</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/type/ConversionResult.html" title="interface in net.sf.saxon.type">ConversionResult</A> <B>makeDecimalValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> in, boolean validate)</PRE> <DL> <DD>Factory method to construct a DecimalValue from a string <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>in</CODE> - the value of the DecimalValue<DD><CODE>validate</CODE> - true if validation is required; false if the caller knows that the value is valid <DT><B>Returns:</B><DD>the required DecimalValue if the input is valid, or a ValidationFailure encapsulating the error message if not.</DL> </DD> </DL> <HR> <A NAME="castableAsDecimal(java.lang.CharSequence)"><!-- --></A><H3> castableAsDecimal</H3> <PRE> public static boolean <B>castableAsDecimal</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> in)</PRE> <DL> <DD>Test whether a string is castable to a decimal value <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>in</CODE> - the string to be tested <DT><B>Returns:</B><DD>true if the string has the correct format for a decimal</DL> </DD> </DL> <HR> <A NAME="copyAsSubType(net.sf.saxon.type.AtomicType)"><!-- --></A><H3> copyAsSubType</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> <B>copyAsSubType</B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> typeLabel)</PRE> <DL> <DD>Create a copy of this atomic value, with a difNferent type label <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#copyAsSubType(net.sf.saxon.type.AtomicType)">copyAsSubType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>typeLabel</CODE> - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type. <DT><B>Returns:</B><DD>the copied value</DL> </DD> </DL> <HR> <A NAME="getPrimitiveType()"><!-- --></A><H3> getPrimitiveType</H3> <PRE> public <A HREF="../../../../net/sf/saxon/type/BuiltInAtomicType.html" title="class in net.sf.saxon.type">BuiltInAtomicType</A> <B>getPrimitiveType</B>()</PRE> <DL> <DD>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. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getPrimitiveType()">getPrimitiveType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the primitive type</DL> </DD> </DL> <HR> <A NAME="getDoubleValue()"><!-- --></A><H3> getDoubleValue</H3> <PRE> public double <B>getDoubleValue</B>()</PRE> <DL> <DD>Get the numeric value as a double <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#getDoubleValue()">getDoubleValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A double representing this numeric value; NaN if it cannot be converted</DL> </DD> </DL> <HR> <A NAME="getFloatValue()"><!-- --></A><H3> getFloatValue</H3> <PRE> public float <B>getFloatValue</B>()</PRE> <DL> <DD>Get the numeric value converted to a float <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#getFloatValue()">getFloatValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a float representing this numeric value; NaN if it cannot be converted</DL> </DD> </DL> <HR> <A NAME="longValue()"><!-- --></A><H3> longValue</H3> <PRE> public long <B>longValue</B>() throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Return the numeric value as a Java long. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#longValue()">longValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the numeric value as a Java long. This performs truncation towards zero. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if the value cannot be converted</DL> </DD> </DL> <HR> <A NAME="getDecimalValue()"><!-- --></A><H3> getDecimalValue</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> <B>getDecimalValue</B>()</PRE> <DL> <DD>Get the value <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#getDecimalValue()">getDecimalValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a decimal representing this numeric value;</DL> </DD> </DL> <HR> <A NAME="hashCode()"><!-- --></A><H3> hashCode</H3> <PRE> public int <B>hashCode</B>()</PRE> <DL> <DD>Get the hashCode. This must conform to the rules for other NumericValue hashcodes <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the hash code of the numeric value<DT><B>See Also:</B><DD><A HREF="../../../../net/sf/saxon/value/NumericValue.html#hashCode()"><CODE>NumericValue.hashCode()</CODE></A></DL> </DD> </DL> <HR> <A NAME="effectiveBooleanValue()"><!-- --></A><H3> effectiveBooleanValue</H3> <PRE> public boolean <B>effectiveBooleanValue</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#effectiveBooleanValue()">AtomicValue</A></CODE></B></DD> <DD>Get the effective boolean value of the value <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#effectiveBooleanValue()">effectiveBooleanValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true, unless the value is boolean false, numeric zero, or zero-length string</DL> </DD> </DL> <HR> <A NAME="getCanonicalLexicalRepresentation()"><!-- --></A><H3> getCanonicalLexicalRepresentation</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>getCanonicalLexicalRepresentation</B>()</PRE> <DL> <DD>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. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#getCanonicalLexicalRepresentation()">getCanonicalLexicalRepresentation</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A><<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules</DL> </DD> </DL> <HR> <A NAME="getPrimitiveStringValue()"><!-- --></A><H3> getPrimitiveStringValue</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>getPrimitiveStringValue</B>()</PRE> <DL> <DD>Get the value as a String <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getPrimitiveStringValue()">getPrimitiveStringValue</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a String representation of the value</DL> </DD> </DL> <HR> <A NAME="decimalToString(java.math.BigDecimal, net.sf.saxon.tree.util.FastStringBuffer)"><!-- --></A><H3> decimalToString</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A> <B>decimalToString</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</A> value, <A HREF="../../../../net/sf/saxon/tree/util/FastStringBuffer.html" title="class in net.sf.saxon.tree.util">FastStringBuffer</A> fsb)</PRE> <DL> <DD>Convert a decimal value to a string, using the XPath rules for formatting <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - the decimal value to be converted<DD><CODE>fsb</CODE> - the FastStringBuffer to which the value is to be appended <DT><B>Returns:</B><DD>the supplied FastStringBuffer, suitably populated</DL> </DD> </DL> <HR> <A NAME="negate()"><!-- --></A><H3> negate</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>negate</B>()</PRE> <DL> <DD>Negate the value <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#negate()">negate</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a value, of the same type as the original, with its sign inverted</DL> </DD> </DL> <HR> <A NAME="floor()"><!-- --></A><H3> floor</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>floor</B>()</PRE> <DL> <DD>Implement the XPath floor() function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#floor()">floor</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a value, of the same type as that supplied, rounded towards minus infinity</DL> </DD> </DL> <HR> <A NAME="ceiling()"><!-- --></A><H3> ceiling</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>ceiling</B>()</PRE> <DL> <DD>Implement the XPath ceiling() function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#ceiling()">ceiling</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a value, of the same type as that supplied, rounded towards plus infinity</DL> </DD> </DL> <HR> <A NAME="round(int)"><!-- --></A><H3> round</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>round</B>(int scale)</PRE> <DL> <DD>Implement the XPath round() function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#round(int)">round</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)</DL> </DD> </DL> <HR> <A NAME="roundHalfToEven(int)"><!-- --></A><H3> roundHalfToEven</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>roundHalfToEven</B>(int scale)</PRE> <DL> <DD>Implement the XPath round-half-to-even() function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#roundHalfToEven(int)">roundHalfToEven</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>scale</CODE> - the decimal position for rounding: e.g. 2 rounds to a multiple of 0.01, while -2 rounds to a multiple of 100 <DT><B>Returns:</B><DD>a value, of the same type as the original, rounded towards the nearest multiple of 10**(-scale), with rounding towards the nearest even number if two values are equally near</DL> </DD> </DL> <HR> <A NAME="signum()"><!-- --></A><H3> signum</H3> <PRE> public int <B>signum</B>()</PRE> <DL> <DD>Determine whether the value is negative, zero, or positive <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#signum()">signum</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>-1 if negative, 0 if zero, +1 if positive, NaN if NaN</DL> </DD> </DL> <HR> <A NAME="isWholeNumber()"><!-- --></A><H3> isWholeNumber</H3> <PRE> public boolean <B>isWholeNumber</B>()</PRE> <DL> <DD>Determine whether the value is a whole number, that is, whether it compares equal to some integer <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#isWholeNumber()">isWholeNumber</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true if the value is a whole number</DL> </DD> </DL> <HR> <A NAME="abs()"><!-- --></A><H3> abs</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A> <B>abs</B>()</PRE> <DL> <DD>Get the absolute value as defined by the XPath abs() function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#abs()">abs</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the absolute value<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3> compareTo</H3> <PRE> public int <B>compareTo</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE> <DL> <DD>Compare the value to another numeric value <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#compareTo(java.lang.Object)">compareTo</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>other</CODE> - The other numeric value <DT><B>Returns:</B><DD>-1 if this one is the lower, 0 if they are numerically equal, +1 if this one is the higher, or if either value is NaN. Where NaN values are involved, they should be handled by the caller before invoking this method.</DL> </DD> </DL> <HR> <A NAME="compareTo(long)"><!-- --></A><H3> compareTo</H3> <PRE> public int <B>compareTo</B>(long other)</PRE> <DL> <DD>Compare the value to a long <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html#compareTo(long)">compareTo</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/NumericValue.html" title="class in net.sf.saxon.value">NumericValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>other</CODE> - the value to be compared with <DT><B>Returns:</B><DD>-1 if this is less, 0 if this is equal, +1 if this is greater or if this is NaN</DL> </DD> </DL> <HR> <A NAME="getSchemaComparable()"><!-- --></A><H3> getSchemaComparable</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A> <B>getSchemaComparable</B>()</PRE> <DL> <DD>Get an object that implements XML Schema comparison semantics <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#getSchemaComparable()">getSchemaComparable</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a Comparable that follows XML Schema comparison rules</DL> </DD> </DL> <HR> <A NAME="isIdentical(net.sf.saxon.value.Value)"><!-- --></A><H3> isIdentical</H3> <PRE> public boolean <B>isIdentical</B>(<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> v)</PRE> <DL> <DD>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. <p>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.</p> <p>NaN is identical to itself.</p> <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html#isIdentical(net.sf.saxon.value.Value)">isIdentical</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>v</CODE> - the other value to be compared with this one <DT><B>Returns:</B><DD>true if the two values are identical, false otherwise.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/value/DayTimeDurationValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/value/DecimalValue.DecimalComparable.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/value/DecimalValue.html" target="_top"><B>FRAMES</B></A> <A HREF="DecimalValue.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>