<!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:26 GMT 2011 -->
<TITLE>
XdmAtomicValue
</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="XdmAtomicValue";
}
}
</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/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XdmDestination.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XdmAtomicValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="XdmAtomicValue.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <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.s9api</FONT>
<BR>
Class XdmAtomicValue</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/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">net.sf.saxon.s9api.XdmValue</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">net.sf.saxon.s9api.XdmItem</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.s9api.XdmAtomicValue</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A>></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>XdmAtomicValue</B><DT>extends <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A></DL>
</PRE>
<P>
The class XdmAtomicValue represents an item in an XPath 2.0 sequence that is an atomic value.
The value may belong to any of the 19 primitive types defined in XML Schema, or to a type
derived from these primitive types, or the XPath 2.0 type xs:untypedAtomic. The type may
be either a built-in type or a user-defined type.
<p>An <code>XdmAtomicValue</code> is immutable.</p>
<P>
<P>
<HR>
<P>
<!-- ======== 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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(net.sf.saxon.value.AtomicValue)">XdmAtomicValue</A></B>(<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> value)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(java.math.BigDecimal)">XdmAtomicValue</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>
Create an <tt>xs:decimal</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(boolean)">XdmAtomicValue</A></B>(boolean value)</CODE>
<BR>
Create an <tt>xs:boolean</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(double)">XdmAtomicValue</A></B>(double value)</CODE>
<BR>
Create an <tt>xs:double</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(float)">XdmAtomicValue</A></B>(float value)</CODE>
<BR>
Create an <tt>xs:float</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(long)">XdmAtomicValue</A></B>(long value)</CODE>
<BR>
Create an <tt>xs:integer</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(net.sf.saxon.s9api.QName)">XdmAtomicValue</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> value)</CODE>
<BR>
Create an <tt>xs:QName</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(java.lang.String)">XdmAtomicValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE>
<BR>
Create an <tt>xs:string</tt> atomic value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(java.lang.String, net.sf.saxon.s9api.ItemType)">XdmAtomicValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> lexicalForm,
<A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> type)</CODE>
<BR>
Construct an atomic value given its lexical representation and the name of the required
built-in atomic type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#XdmAtomicValue(java.net.URI)">XdmAtomicValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> value)</CODE>
<BR>
Create an <tt>xs:anyURI</tt> atomic value</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#getBooleanValue()">getBooleanValue</A></B>()</CODE>
<BR>
Get the value converted to a boolean using the XPath casting rules</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/s9api/XdmAtomicValue.html#getDecimalValue()">getDecimalValue</A></B>()</CODE>
<BR>
Get the value converted to a decimal using the XPath casting rules</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/s9api/XdmAtomicValue.html#getDoubleValue()">getDoubleValue</A></B>()</CODE>
<BR>
Get the value converted to a double using the XPath casting rules.</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/s9api/XdmAtomicValue.html#getLongValue()">getLongValue</A></B>()</CODE>
<BR>
Get the value converted to an integer using the XPath casting rules</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#getPrimitiveTypeName()">getPrimitiveTypeName</A></B>()</CODE>
<BR>
Get the primitive type of this atomic value, as a QName.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#getValue()">getValue</A></B>()</CODE>
<BR>
Get the value as a Java object of the nearest equivalent type.</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/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html#toString()">toString</A></B>()</CODE>
<BR>
Get the result of converting the atomic value to a string.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.s9api.XdmItem"><!-- --></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.s9api.<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#isAtomicValue()">isAtomicValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#newAtomicValue(java.lang.String, net.sf.saxon.s9api.ItemType)">newAtomicValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#size()">size</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#wrapItem(net.sf.saxon.om.Item)">wrapItem</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.s9api.XdmValue"><!-- --></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.s9api.<A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#append(net.sf.saxon.s9api.XdmValue)">append</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#getUnderlyingValue()">getUnderlyingValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#itemAt(int)">itemAt</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#iterator()">iterator</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#setValue(net.sf.saxon.om.ValueRepresentation)">setValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#wrap(net.sf.saxon.om.ValueRepresentation)">wrap</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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>
<!-- ========= 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="XdmAtomicValue(net.sf.saxon.value.AtomicValue)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
protected <B>XdmAtomicValue</B>(<A HREF="../../../../net/sf/saxon/value/AtomicValue.html" title="class in net.sf.saxon.value">AtomicValue</A> value)</PRE>
<DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(boolean)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(boolean value)</PRE>
<DL>
<DD>Create an <tt>xs:boolean</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the boolean value, true or false</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(long)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(long value)</PRE>
<DL>
<DD>Create an <tt>xs:integer</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:integer</tt> value, as a long</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(java.math.BigDecimal)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</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>Create an <tt>xs:decimal</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:decimal</tt> value, as a BigDecimal</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(double)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(double value)</PRE>
<DL>
<DD>Create an <tt>xs:double</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:double</tt> value, as a double</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(float)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(float value)</PRE>
<DL>
<DD>Create an <tt>xs:float</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:float</tt> value, as a float</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(java.lang.String)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE>
<DL>
<DD>Create an <tt>xs:string</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:string</tt> value, as a string</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(java.net.URI)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> value)</PRE>
<DL>
<DD>Create an <tt>xs:anyURI</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:anyURI</tt> value, as a URI</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(net.sf.saxon.s9api.QName)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> value)</PRE>
<DL>
<DD>Create an <tt>xs:QName</tt> atomic value
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the <tt>xs:QName</tt> value, as a QName</DL>
</DL>
<HR>
<A NAME="XdmAtomicValue(java.lang.String, net.sf.saxon.s9api.ItemType)"><!-- --></A><H3>
XdmAtomicValue</H3>
<PRE>
public <B>XdmAtomicValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> lexicalForm,
<A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> type)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Construct an atomic value given its lexical representation and the name of the required
built-in atomic type.
<p>This method cannot be used to construct values that are namespace-sensitive (QNames and Notations)</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>lexicalForm</CODE> - the value in the lexical space of the target data type. More strictly, the input
value before the actions of the whitespace facet for the target data type are applied.<DD><CODE>type</CODE> - the required atomic type. This must either be one of the built-in
atomic types defined in XML Schema, or a user-defined type whose definition appears
in a schema that is known to the Processor. It must not be an abstract type.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the type is unknown, or is not atomic, or is namespace-sensitive;
or if the value supplied in <tt>lexicalForm</tt> is not in the lexical space of the specified atomic
type.</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="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
<DL>
<DD>Get the result of converting the atomic value to a string. This has the same
effect as the XPath string() function.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><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></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPrimitiveTypeName()"><!-- --></A><H3>
getPrimitiveTypeName</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> <B>getPrimitiveTypeName</B>()</PRE>
<DL>
<DD>Get the primitive type of this atomic value, as a QName. The primitive types for this purpose 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 xs:anyAtomicType.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a QName naming the primitive type of this atomic value. This will always be an atomic type.</DL>
</DD>
</DL>
<HR>
<A NAME="getValue()"><!-- --></A><H3>
getValue</H3>
<PRE>
public <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>getValue</B>()</PRE>
<DL>
<DD>Get the value as a Java object of the nearest equivalent type.
<p>The result type is as follows:</p>
<table>
<tr><th>XPath type</th> <th>Java class</th></tr>
<tr><td>xs:string</td> <td>String</td></tr>
<tr><td>xs:integer</td> <td>java.math.BigInteger</td></tr>
<tr><td>xs:decimal</td> <td>java.math.BigDecimal</td></tr>
<tr><td>xs:double</td> <td>Double</td></tr>
<tr><td>xs:float</td> <td>Float</td></tr>
<tr><td>xs:boolean</td> <td>Boolean</td></tr>
<tr><td>xs:QName</td> <td>QName</td></tr>
<tr><td>xs:anyURI</td> <td>String</td></tr>
<tr><td>xs:untypedAtomic</td><td>String</td></tr>
<tr><td>Other types</td> <td>currently String, but this may change in the future</td></tr>
</table>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value, converted to a Java object of a suitable type</DL>
</DD>
</DL>
<HR>
<A NAME="getBooleanValue()"><!-- --></A><H3>
getBooleanValue</H3>
<PRE>
public boolean <B>getBooleanValue</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get the value converted to a boolean using the XPath casting rules
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the result of converting to a boolean (Note: this is not the same as the
effective boolean value).
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the value cannot be cast to a boolean</DL>
</DD>
</DL>
<HR>
<A NAME="getLongValue()"><!-- --></A><H3>
getLongValue</H3>
<PRE>
public long <B>getLongValue</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get the value converted to an integer using the XPath casting rules
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the result of converting to an integer
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the value cannot be cast to an integer</DL>
</DD>
</DL>
<HR>
<A NAME="getDoubleValue()"><!-- --></A><H3>
getDoubleValue</H3>
<PRE>
public double <B>getDoubleValue</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get the value converted to a double using the XPath casting rules.
<p>If the value is a string, the XSD 1.1 rules are used, which means that the string
"+INF" is recognised.</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the result of converting to a double
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the value cannot be cast to a double</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>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get the value converted to a decimal using the XPath casting rules
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the result of converting to a decimal
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the value cannot be cast to a double</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/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XdmDestination.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XdmAtomicValue.html" target="_top"><B>FRAMES</B></A>
<A HREF="XdmAtomicValue.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <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>
