blob: b637db997d57f91e535c1b7e308fca80fd72e90d [file] [log] [blame]
<!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.5.0_06) on Wed Jul 19 14:42:54 EDT 2006 -->
<TITLE>
XMLDecoder (Cayenne API Documentation - v.1.2)
</TITLE>
<META NAME="keywords" CONTENT="org.objectstyle.cayenne.xml.XMLDecoder class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="XMLDecoder (Cayenne API Documentation - v.1.2)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/xml/XMLEncoder.html" title="class in org.objectstyle.cayenne.xml"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/xml/XMLDecoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="XMLDecoder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
org.objectstyle.cayenne.xml</FONT>
<BR>
Class XMLDecoder</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.xml.XMLDecoder</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>XMLDecoder</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
XMLDecoder is used to decode XML into objects.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</DD>
<DT><B>Author:</B></DT>
<DD>Kevin J. Menard, Jr.</DD>
</DL>
<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><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#XMLDecoder()">XMLDecoder</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#XMLDecoder(org.objectstyle.cayenne.access.DataContext)">XMLDecoder</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an XMLDecoder that will register decoded DataObjects with the specified
DataContext.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decode(java.io.Reader)">decode</A></B>(java.io.Reader&nbsp;xml)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes XML wrapped by a Reader into an object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decode(java.io.Reader, java.lang.String)">decode</A></B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes XML wrapped by a Reader into an object, using the supplied mapping file to
guide the decoding process.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeBoolean(java.lang.String)">decodeBoolean</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an XML element to a Boolean.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeDouble(java.lang.String)">decodeDouble</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an XML element to a Double.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Float</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeFloat(java.lang.String)">decodeFloat</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an XML element to a Float.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Integer</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeInteger(java.lang.String)">decodeInteger</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an XML element to an Integer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeList(java.io.Reader)">decodeList</A></B>(java.io.Reader&nbsp;xml)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes a list of DataObjects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeList(java.io.Reader, org.objectstyle.cayenne.access.DataContext)">decodeList</A></B>(java.io.Reader&nbsp;xml,
<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dc)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes a list of DataObjects, registering them the supplied DataContext.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeList(java.io.Reader, java.lang.String)">decodeList</A></B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes a list of DataObjects using the supplied mapping file to guide the decoding
process.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeList(java.io.Reader, java.lang.String, org.objectstyle.cayenne.access.DataContext)">decodeList</A></B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl,
<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dataContext)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes a list of DataObjects using the supplied mapping file to guide the decoding
process, registering them the supplied DataContext.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeObject(java.lang.String)">decodeObject</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an object from XML.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#decodeString(java.lang.String)">decodeString</A></B>(java.lang.String&nbsp;xmlTag)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decodes an XML element to a String.</TD>
</TR>
</TABLE>
&nbsp;<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.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="XMLDecoder()"><!-- --></A><H3>
XMLDecoder</H3>
<PRE>
public <B>XMLDecoder</B>()</PRE>
<DL>
<DD>Default constructor. This will create an XMLDecoder instance that will decode
objects from XML, but will not register them with any DataContext.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/objectstyle/cayenne/xml/XMLDecoder.html#XMLDecoder(org.objectstyle.cayenne.access.DataContext)"><CODE>XMLDecoder(DataContext)</CODE></A></DL>
</DL>
<HR>
<A NAME="XMLDecoder(org.objectstyle.cayenne.access.DataContext)"><!-- --></A><H3>
XMLDecoder</H3>
<PRE>
public <B>XMLDecoder</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dc)</PRE>
<DL>
<DD>Creates an XMLDecoder that will register decoded DataObjects with the specified
DataContext.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>dc</CODE> - The DataContext to register decoded DataObjects with.</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="decodeBoolean(java.lang.String)"><!-- --></A><H3>
decodeBoolean</H3>
<PRE>
public java.lang.Boolean <B>decodeBoolean</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an XML element to a Boolean.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The tag identifying the element.
<DT><B>Returns:</B><DD>The tag's value.</DL>
</DD>
</DL>
<HR>
<A NAME="decodeDouble(java.lang.String)"><!-- --></A><H3>
decodeDouble</H3>
<PRE>
public java.lang.Double <B>decodeDouble</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an XML element to a Double.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The tag identifying the element.
<DT><B>Returns:</B><DD>The tag's value.</DL>
</DD>
</DL>
<HR>
<A NAME="decodeFloat(java.lang.String)"><!-- --></A><H3>
decodeFloat</H3>
<PRE>
public java.lang.Float <B>decodeFloat</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an XML element to a Float.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The tag identifying the element.
<DT><B>Returns:</B><DD>The tag's value.</DL>
</DD>
</DL>
<HR>
<A NAME="decodeInteger(java.lang.String)"><!-- --></A><H3>
decodeInteger</H3>
<PRE>
public java.lang.Integer <B>decodeInteger</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an XML element to an Integer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The tag identifying the element.
<DT><B>Returns:</B><DD>The tag's value.</DL>
</DD>
</DL>
<HR>
<A NAME="decodeObject(java.lang.String)"><!-- --></A><H3>
decodeObject</H3>
<PRE>
public java.lang.Object <B>decodeObject</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an object from XML.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The XML tag corresponding to the root of the encoded object.
<DT><B>Returns:</B><DD>The decoded object.</DL>
</DD>
</DL>
<HR>
<A NAME="decodeString(java.lang.String)"><!-- --></A><H3>
decodeString</H3>
<PRE>
public java.lang.String <B>decodeString</B>(java.lang.String&nbsp;xmlTag)</PRE>
<DL>
<DD>Decodes an XML element to a String.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlTag</CODE> - The tag identifying the element.
<DT><B>Returns:</B><DD>The tag's value.</DL>
</DD>
</DL>
<HR>
<A NAME="decode(java.io.Reader)"><!-- --></A><H3>
decode</H3>
<PRE>
public java.lang.Object <B>decode</B>(java.io.Reader&nbsp;xml)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes XML wrapped by a Reader into an object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - Wrapped XML.
<DT><B>Returns:</B><DD>A new instance of the object represented by the XML.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="decode(java.io.Reader, java.lang.String)"><!-- --></A><H3>
decode</H3>
<PRE>
public java.lang.Object <B>decode</B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes XML wrapped by a Reader into an object, using the supplied mapping file to
guide the decoding process.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - Wrapped XML.<DD><CODE>mappingUrl</CODE> - Mapping file describing how the XML elements and object
properties correlate.
<DT><B>Returns:</B><DD>A new instance of the object represented by the XML.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="decodeList(java.io.Reader)"><!-- --></A><H3>
decodeList</H3>
<PRE>
public static java.util.List <B>decodeList</B>(java.io.Reader&nbsp;xml)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes a list of DataObjects.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - The wrapped XML encoding of the list of DataObjects.
<DT><B>Returns:</B><DD>The list of decoded DataObjects.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="decodeList(java.io.Reader, org.objectstyle.cayenne.access.DataContext)"><!-- --></A><H3>
decodeList</H3>
<PRE>
public static java.util.List <B>decodeList</B>(java.io.Reader&nbsp;xml,
<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dc)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes a list of DataObjects, registering them the supplied DataContext.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - The wrapped XML encoding of the list of DataObjects.<DD><CODE>dc</CODE> - The DataContext to register the decode DataObjects with.
<DT><B>Returns:</B><DD>The list of decoded DataObjects.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="decodeList(java.io.Reader, java.lang.String)"><!-- --></A><H3>
decodeList</H3>
<PRE>
public static java.util.List <B>decodeList</B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes a list of DataObjects using the supplied mapping file to guide the decoding
process.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - The wrapped XML encoding of the list of DataObjects.<DD><CODE>mappingUrl</CODE> - Mapping file describing how the XML elements and object
properties correlate.
<DT><B>Returns:</B><DD>The list of decoded DataObjects.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="decodeList(java.io.Reader, java.lang.String, org.objectstyle.cayenne.access.DataContext)"><!-- --></A><H3>
decodeList</H3>
<PRE>
public static java.util.List <B>decodeList</B>(java.io.Reader&nbsp;xml,
java.lang.String&nbsp;mappingUrl,
<A HREF="../../../../org/objectstyle/cayenne/access/DataContext.html" title="class in org.objectstyle.cayenne.access">DataContext</A>&nbsp;dataContext)
throws <A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></PRE>
<DL>
<DD>Decodes a list of DataObjects using the supplied mapping file to guide the decoding
process, registering them the supplied DataContext.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xml</CODE> - The wrapped XML encoding of the list of objects.<DD><CODE>mappingUrl</CODE> - Mapping file describing how the XML elements and object
properties correlate.<DD><CODE>dataContext</CODE> - The DataContext to register the decode DataObjects with.
<DT><B>Returns:</B><DD>The list of decoded DataObjects.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneRuntimeException.html" title="class in org.objectstyle.cayenne">CayenneRuntimeException</A></CODE></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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/xml/XMLEncoder.html" title="class in org.objectstyle.cayenne.xml"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/xml/XMLDecoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="XMLDecoder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<!--@SFLOGO@--> &nbsp; <i>Copyright &#169; 2001-2006 <a href=
"http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i>
</BODY>
</HTML>