You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by ri...@apache.org on 2006/05/26 22:16:46 UTC

svn commit: r409732 [6/13] - in /incubator/tuscany/site/src/site/resources/javadoc/sdo-api: ./ apidocs/ commonj/ commonj/sdo/ commonj/sdo/class-use/ commonj/sdo/helper/ commonj/sdo/helper/class-use/ commonj/sdo/impl/ commonj/sdo/impl/class-use/ css/ im...

Added: incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/EqualityHelper.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/EqualityHelper.html?rev=409732&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/EqualityHelper.html (added)
+++ incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/EqualityHelper.html Fri May 26 13:16:40 2006
@@ -0,0 +1,324 @@
+<!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 Mon May 15 07:31:54 EDT 2006 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+EqualityHelper (SDO API incubating-M1 API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="commonj.sdo.helper.EqualityHelper interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="EqualityHelper (SDO API incubating-M1 API)";
+}
+</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="class-use/EqualityHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/DataHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/EqualityHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="EqualityHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&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">
+commonj.sdo.helper</FONT>
+<BR>
+Interface EqualityHelper</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>EqualityHelper</B></DL>
+</PRE>
+
+<P>
+A helper for comparing DataObjects.
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- =========== 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&nbsp;<A HREF="../../../commonj/sdo/helper/EqualityHelper.html" title="interface in commonj.sdo.helper">EqualityHelper</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/EqualityHelper.html#INSTANCE">INSTANCE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default EqualityHelper.</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;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/EqualityHelper.html#equal(commonj.sdo.DataObject, commonj.sdo.DataObject)">equal</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject1,
+      <A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject2)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Two DataObjects are equal(Deep) if they are equalShallow,
+  all their compared Properties are equal, and all reachable DataObjects in their
+  graphs excluding containers are equal.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/EqualityHelper.html#equalShallow(commonj.sdo.DataObject, commonj.sdo.DataObject)">equalShallow</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject1,
+             <A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject2)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Two DataObjects are equalShallow if
+  they have the same <A HREF="../../../commonj/sdo/DataObject.html#getType()"><CODE>Type</CODE></A>
+  and all their compared Properties are equal.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<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="INSTANCE"><!-- --></A><H3>
+INSTANCE</H3>
+<PRE>
+static final <A HREF="../../../commonj/sdo/helper/EqualityHelper.html" title="interface in commonj.sdo.helper">EqualityHelper</A> <B>INSTANCE</B></PRE>
+<DL>
+<DD>The default EqualityHelper.
+<P>
+<DL>
+</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="equalShallow(commonj.sdo.DataObject, commonj.sdo.DataObject)"><!-- --></A><H3>
+equalShallow</H3>
+<PRE>
+boolean <B>equalShallow</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject1,
+                     <A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject2)</PRE>
+<DL>
+<DD><p>Two DataObjects are equalShallow if
+  they have the same <A HREF="../../../commonj/sdo/DataObject.html#getType()"><CODE>Type</CODE></A>
+  and all their compared Properties are equal.
+  The set of Properties compared are the 
+  <A HREF="../../../commonj/sdo/DataObject.html#getInstanceProperties()"><CODE>instance properties</CODE></A>
+  where property.getType().isDataType() is true
+  and property.getType() is not ChangeSummaryType.
+ <br/>Two of these Property values are equal if they are both not
+  <A HREF="../../../commonj/sdo/DataObject.html#isSet(commonj.sdo.Property)"><CODE>set</CODE></A>, or set to an equal value
+  dataObject1.get(property).equals(dataObject2.get(property))
+ <br/>If the type is a sequenced type, the sequence entries must be the same.
+  For each entry x in the sequence where the property is used in the comparison,
+  dataObject1.getSequence().getValue(x).equals(
+   dataObject2.getSequence().getValue(x)) and
+  dataObject1.getSequence().getProperty(x) == 
+   dataObject2.getSequence().getProperty(x)
+  must be true.
+ </p>
+  Returns true the objects have the same Type and all values of all compared Properties are equal.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>dataObject1</CODE> - DataObject to be compared<DD><CODE>dataObject2</CODE> - DataObject to be compared
+<DT><B>Returns:</B><DD>true the objects have the same Type and all values of all compared Properties are equal.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equal(commonj.sdo.DataObject, commonj.sdo.DataObject)"><!-- --></A><H3>
+equal</H3>
+<PRE>
+boolean <B>equal</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject1,
+              <A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject2)</PRE>
+<DL>
+<DD><p>Two DataObjects are equal(Deep) if they are equalShallow,
+  all their compared Properties are equal, and all reachable DataObjects in their
+  graphs excluding containers are equal.
+  The set of Properties compared are the 
+  <A HREF="../../../commonj/sdo/DataObject.html#getInstanceProperties()"><CODE>instance properties</CODE></A>
+  where property.getType().isDataType() is false, 
+  and is not a container property, ie !property.getOpposite().isContainment()
+ <br/>Two of these Property values are equal if they are both not
+  <A HREF="../../../commonj/sdo/DataObject.html#isSet(commonj.sdo.Property)"><CODE>set</CODE></A>, or all the DataObjects
+  they refer to are <A HREF="../../../commonj/sdo/helper/EqualityHelper.html#equal(commonj.sdo.DataObject, commonj.sdo.DataObject)"><CODE>equal</CODE></A> in the 
+  context of dataObject1 and dataObject2.
+ <br/>Note that properties to a containing DataObject are not compared
+  which means two DataObject trees can be equal even if their containers are not equal.
+ <br/>If the type is a sequenced type, the sequence entries must be the same.
+  For each entry x in the sequence where the property is used in the comparison,
+  equal(dataObject1.getSequence().getValue(x), 
+   dataObject2.getSequence().getValue(x)) and
+  dataObject1.getSequence().getProperty(x) == 
+   dataObject2.getSequence().getProperty(x)
+  must be true.
+ </p><p>
+ A DataObject directly or indirectly referenced by dataObject1 or dataObject2 
+  can only be equal to exactly one DataObject directly or indirectly referenced 
+  by dataObject1 or dataObject2, respectively.
+  This ensures that dataObject1 and dataObject2 are equal if the graph formed by 
+  all their referenced DataObjects have the same shape.
+ </p>
+  Returns true if the trees of DataObjects are equal(Deep).
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>dataObject1</CODE> - DataObject to be compared<DD><CODE>dataObject2</CODE> - DataObject to be compared
+<DT><B>Returns:</B><DD>true if the trees of DataObjects are equal(Deep).</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="class-use/EqualityHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/DataHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/EqualityHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="EqualityHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+-
+</BODY>
+</HTML>

Added: incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/TypeHelper.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/TypeHelper.html?rev=409732&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/TypeHelper.html (added)
+++ incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/TypeHelper.html Fri May 26 13:16:40 2006
@@ -0,0 +1,330 @@
+<!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 Mon May 15 07:31:54 EDT 2006 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+TypeHelper (SDO API incubating-M1 API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="commonj.sdo.helper.TypeHelper interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="TypeHelper (SDO API incubating-M1 API)";
+}
+</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="class-use/TypeHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/EqualityHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/TypeHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="TypeHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&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">
+commonj.sdo.helper</FONT>
+<BR>
+Interface TypeHelper</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>TypeHelper</B></DL>
+</PRE>
+
+<P>
+Look up a Type given the uri and typeName or interfaceClass.
+ SDO Types are available through the
+   getType("commonj.sdo", typeName) method.
+ Defines Types from DataObjects.
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- =========== 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&nbsp;<A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper">TypeHelper</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/TypeHelper.html#INSTANCE">INSTANCE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default TypeHelper.</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;<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/TypeHelper.html#define(commonj.sdo.DataObject)">define</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;type)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Define the DataObject as a Type.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.util.List</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/TypeHelper.html#define(java.util.List)">define</A></B>(java.util.List&nbsp;types)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Define the list of DataObjects as Types.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/TypeHelper.html#getType(java.lang.Class)">getType</A></B>(java.lang.Class&nbsp;interfaceClass)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the Type for this interfaceClass or null if not found.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/TypeHelper.html#getType(java.lang.String, java.lang.String)">getType</A></B>(java.lang.String&nbsp;uri,
+        java.lang.String&nbsp;typeName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the Type specified by typeName with the given uri,
+   or null if not found.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<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="INSTANCE"><!-- --></A><H3>
+INSTANCE</H3>
+<PRE>
+static final <A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper">TypeHelper</A> <B>INSTANCE</B></PRE>
+<DL>
+<DD>The default TypeHelper.
+<P>
+<DL>
+</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="getType(java.lang.String, java.lang.String)"><!-- --></A><H3>
+getType</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A> <B>getType</B>(java.lang.String&nbsp;uri,
+             java.lang.String&nbsp;typeName)</PRE>
+<DL>
+<DD>Return the Type specified by typeName with the given uri,
+   or null if not found.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>uri</CODE> - The uri of the Type - type.getURI();<DD><CODE>typeName</CODE> - The name of the Type - type.getName();
+<DT><B>Returns:</B><DD>the Type specified by typeName with the given uri,
+   or null if not found.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getType(java.lang.Class)"><!-- --></A><H3>
+getType</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A> <B>getType</B>(java.lang.Class&nbsp;interfaceClass)</PRE>
+<DL>
+<DD>Return the Type for this interfaceClass or null if not found.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>interfaceClass</CODE> - is the interface for the DataObject's Type -  
+   type.getInstanceClass();
+<DT><B>Returns:</B><DD>the Type for this interfaceClass or null if not found.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="define(commonj.sdo.DataObject)"><!-- --></A><H3>
+define</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/Type.html" title="interface in commonj.sdo">Type</A> <B>define</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;type)</PRE>
+<DL>
+<DD>Define the DataObject as a Type.
+ The Type is available through TypeHelper and DataGraph getType() methods.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>type</CODE> - the DataObject representing the Type.
+<DT><B>Returns:</B><DD>the defined Type.
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the Type could not be defined.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="define(java.util.List)"><!-- --></A><H3>
+define</H3>
+<PRE>
+java.util.List <B>define</B>(java.util.List&nbsp;types)</PRE>
+<DL>
+<DD>Define the list of DataObjects as Types.
+ The Types are available through TypeHelper and DataGraph getType() methods.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>types</CODE> - a List of DataObjects representing the Types.
+<DT><B>Returns:</B><DD>the defined Types.
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the Types could not be defined.</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="class-use/TypeHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/EqualityHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/TypeHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="TypeHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+-
+</BODY>
+</HTML>

Added: incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLDocument.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLDocument.html?rev=409732&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLDocument.html (added)
+++ incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLDocument.html Fri May 26 13:16:40 2006
@@ -0,0 +1,530 @@
+<!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 Mon May 15 07:31:54 EDT 2006 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+XMLDocument (SDO API incubating-M1 API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="commonj.sdo.helper.XMLDocument interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="XMLDocument (SDO API incubating-M1 API)";
+}
+</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="class-use/XMLDocument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/XMLDocument.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="XMLDocument.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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">
+commonj.sdo.helper</FONT>
+<BR>
+Interface XMLDocument</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>XMLDocument</B></DL>
+</PRE>
+
+<P>
+Represents an XML Document containing a tree of DataObjects.
+ 
+ An example XMLDocument fragment is:
+ <?xml version="1.0"?>
+ <purchaseOrder orderDate="1999-10-20">
+ 
+ created from this XML Schema fragment:
+ <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+   <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
+   <xsd:complexType name="PurchaseOrderType">
+
+ Upon loading this XMLDocument:
+   DataObject is an instance of Type PurchaseOrderType.
+   RootElementURI is null because the XSD has no targetNamespace URI.
+   RootElementName is purchaseOrder.
+   Encoding is null because the document did not specify an encoding.
+   XMLDeclaration is true because the document contained an XML declaration.
+   XMLVersion is 1.0
+   SchemaLocation and noNamespaceSchemaLocation are null because they are
+     not specified in the document.
+ 
+ When saving the root element, if the type of the root dataObject is not the
+   type of global element specified by rootElementURI and rootElementName, 
+   or if a global element does not exist for rootElementURI and rootElementName,
+   then an xsi:type declaration is written to record the root DataObject's Type.
+ 
+ When loading the root element and an xsi:type declaration is found
+   it is used as the type of the root DataObject.  In this case,
+   if validation is not being performed, it is not an error if the
+   rootElementName is not a global element.
+<P>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ========== 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.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#getEncoding()">getEncoding</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the XML encoding of the document, or null if not specified.</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="../../../commonj/sdo/helper/XMLDocument.html#getNoNamespaceSchemaLocation()">getNoNamespaceSchemaLocation</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the value of the noNamespaceSchemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if not present.</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="../../../commonj/sdo/helper/XMLDocument.html#getRootElementName()">getRootElementName</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the name of the root element.</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="../../../commonj/sdo/helper/XMLDocument.html#getRootElementURI()">getRootElementURI</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the targetNamespace URI for the root element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#getRootObject()">getRootObject</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the root DataObject for the XMLDocument.</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="../../../commonj/sdo/helper/XMLDocument.html#getSchemaLocation()">getSchemaLocation</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the value of the schemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if not present.</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="../../../commonj/sdo/helper/XMLDocument.html#getXMLVersion()">getXMLVersion</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the XML version of the document, or null if not specified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#isXMLDeclaration()">isXMLDeclaration</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the XML declaration of the document.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the XML encoding of the document, or null if not specified.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#setNoNamespaceSchemaLocation(java.lang.String)">setNoNamespaceSchemaLocation</A></B>(java.lang.String&nbsp;schemaLocation)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value of the noNamespaceSchemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if it should not be present.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#setSchemaLocation(java.lang.String)">setSchemaLocation</A></B>(java.lang.String&nbsp;schemaLocation)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value of the schemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if it should not be present.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#setXMLDeclaration(boolean)">setXMLDeclaration</A></B>(boolean&nbsp;xmlDeclaration)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the XML declaration version of the document.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLDocument.html#setXMLVersion(java.lang.String)">setXMLVersion</A></B>(java.lang.String&nbsp;xmlVersion)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the XML version of the document, or null if not specified.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ============ 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="getRootObject()"><!-- --></A><H3>
+getRootObject</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> <B>getRootObject</B>()</PRE>
+<DL>
+<DD>Return the root DataObject for the XMLDocument.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>root DataObject for the XMLDocument.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRootElementURI()"><!-- --></A><H3>
+getRootElementURI</H3>
+<PRE>
+java.lang.String <B>getRootElementURI</B>()</PRE>
+<DL>
+<DD>Return the targetNamespace URI for the root element.
+ If there is no targetNamespace URI, the value is null.
+ The root element is a global element of the XML Schema
+   with a type compatible to the DataObject.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the targetNamespace URI for the root element.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRootElementName()"><!-- --></A><H3>
+getRootElementName</H3>
+<PRE>
+java.lang.String <B>getRootElementName</B>()</PRE>
+<DL>
+<DD>Return the name of the root element.
+ The root element is a global element of the XML Schema
+   with a type compatible to the DataObject.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the name of the root element.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getEncoding()"><!-- --></A><H3>
+getEncoding</H3>
+<PRE>
+java.lang.String <B>getEncoding</B>()</PRE>
+<DL>
+<DD>Return the XML encoding of the document, or null if not specified.
+ The default value is "UTF-8".
+ Specification of other values is implementation-dependent.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the XML encoding of the document, or null if not specified.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
+setEncoding</H3>
+<PRE>
+void <B>setEncoding</B>(java.lang.String&nbsp;encoding)</PRE>
+<DL>
+<DD>Set the XML encoding of the document, or null if not specified.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isXMLDeclaration()"><!-- --></A><H3>
+isXMLDeclaration</H3>
+<PRE>
+boolean <B>isXMLDeclaration</B>()</PRE>
+<DL>
+<DD>Return the XML declaration of the document.  If true,
+   XMLHelper save() will produce a declaration of the form:
+ <?xml version="1.0" encoding="UTF-8"?>
+   Encoding will be suppressed if getEncoding() is null.
+ The default value is true.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the XML declaration of the document.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setXMLDeclaration(boolean)"><!-- --></A><H3>
+setXMLDeclaration</H3>
+<PRE>
+void <B>setXMLDeclaration</B>(boolean&nbsp;xmlDeclaration)</PRE>
+<DL>
+<DD>Set the XML declaration version of the document.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>xmlDeclaration</CODE> - the XML declaration version of the document.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getXMLVersion()"><!-- --></A><H3>
+getXMLVersion</H3>
+<PRE>
+java.lang.String <B>getXMLVersion</B>()</PRE>
+<DL>
+<DD>Return the XML version of the document, or null if not specified. 
+ The default value is "1.0".
+ Specification of other values is implementation-dependent.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the XML version of the document, or null if not specified.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setXMLVersion(java.lang.String)"><!-- --></A><H3>
+setXMLVersion</H3>
+<PRE>
+void <B>setXMLVersion</B>(java.lang.String&nbsp;xmlVersion)</PRE>
+<DL>
+<DD>Set the XML version of the document, or null if not specified.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>xmlVersion</CODE> - the XML version of the document, or null if not specified.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSchemaLocation()"><!-- --></A><H3>
+getSchemaLocation</H3>
+<PRE>
+java.lang.String <B>getSchemaLocation</B>()</PRE>
+<DL>
+<DD>Return the value of the schemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if not present.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the value of the schemaLocation declaration,
+ or null if not present.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setSchemaLocation(java.lang.String)"><!-- --></A><H3>
+setSchemaLocation</H3>
+<PRE>
+void <B>setSchemaLocation</B>(java.lang.String&nbsp;schemaLocation)</PRE>
+<DL>
+<DD>Sets the value of the schemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if it should not be present.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>schemaLocation</CODE> - the value of the schemaLocation declaration, or null.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNoNamespaceSchemaLocation()"><!-- --></A><H3>
+getNoNamespaceSchemaLocation</H3>
+<PRE>
+java.lang.String <B>getNoNamespaceSchemaLocation</B>()</PRE>
+<DL>
+<DD>Return the value of the noNamespaceSchemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if not present.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the value of the noNamespaceSchemaLocation declaration,
+ or null if not present.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setNoNamespaceSchemaLocation(java.lang.String)"><!-- --></A><H3>
+setNoNamespaceSchemaLocation</H3>
+<PRE>
+void <B>setNoNamespaceSchemaLocation</B>(java.lang.String&nbsp;schemaLocation)</PRE>
+<DL>
+<DD>Sets the value of the noNamespaceSchemaLocation declaration
+ for the http://www.w3.org/2001/XMLSchema-instance namespace in the
+ root element, or null if it should not be present.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>schemaLocation</CODE> - the value of the noNamespaceSchemaLocation declaration, or null.</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="class-use/XMLDocument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/TypeHelper.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/XMLDocument.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="XMLDocument.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+-
+</BODY>
+</HTML>

Added: incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLHelper.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLHelper.html?rev=409732&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLHelper.html (added)
+++ incubator/tuscany/site/src/site/resources/javadoc/sdo-api/commonj/sdo/helper/XMLHelper.html Fri May 26 13:16:40 2006
@@ -0,0 +1,520 @@
+<!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 Mon May 15 07:31:54 EDT 2006 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+XMLHelper (SDO API incubating-M1 API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="commonj.sdo.helper.XMLHelper interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="XMLHelper (SDO API incubating-M1 API)";
+}
+</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="class-use/XMLHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XSDHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/XMLHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="XMLHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&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">
+commonj.sdo.helper</FONT>
+<BR>
+Interface XMLHelper</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>XMLHelper</B></DL>
+</PRE>
+
+<P>
+A helper to convert XML documents into DataObects and 
+ DataObjects into XML documnets.
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- =========== 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&nbsp;<A HREF="../../../commonj/sdo/helper/XMLHelper.html" title="interface in commonj.sdo.helper">XMLHelper</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#INSTANCE">INSTANCE</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default XMLHelper.</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;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#createDocument(commonj.sdo.DataObject, java.lang.String, java.lang.String)">createDocument</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+               java.lang.String&nbsp;rootElementURI,
+               java.lang.String&nbsp;rootElementName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an XMLDocument with the specified XML rootElement for the DataObject.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#load(java.io.InputStream)">load</A></B>(java.io.InputStream&nbsp;inputStream)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates and returns an XMLDocument from the inputStream.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#load(java.io.InputStream, java.lang.String, java.lang.Object)">load</A></B>(java.io.InputStream&nbsp;inputStream,
+     java.lang.String&nbsp;locationURI,
+     java.lang.Object&nbsp;options)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates and returns an XMLDocument from the inputStream.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#load(java.io.Reader, java.lang.String, java.lang.Object)">load</A></B>(java.io.Reader&nbsp;inputReader,
+     java.lang.String&nbsp;locationURI,
+     java.lang.Object&nbsp;options)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates and returns an XMLDocument from the inputReader.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#load(java.lang.String)">load</A></B>(java.lang.String&nbsp;inputString)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates and returns an XMLDocument from the input String.</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="../../../commonj/sdo/helper/XMLHelper.html#save(commonj.sdo.DataObject, java.lang.String, java.lang.String)">save</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+     java.lang.String&nbsp;rootElementURI,
+     java.lang.String&nbsp;rootElementName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the DataObject saved as an XML document with the specified root element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#save(commonj.sdo.DataObject, java.lang.String, java.lang.String, java.io.OutputStream)">save</A></B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+     java.lang.String&nbsp;rootElementURI,
+     java.lang.String&nbsp;rootElementName,
+     java.io.OutputStream&nbsp;outputStream)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves the DataObject as an XML document with the specified root element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#save(commonj.sdo.helper.XMLDocument, java.io.OutputStream, java.lang.Object)">save</A></B>(<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A>&nbsp;xmlDocument,
+     java.io.OutputStream&nbsp;outputStream,
+     java.lang.Object&nbsp;options)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serializes an XMLDocument as an XML document into the outputStream.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#save(commonj.sdo.helper.XMLDocument, java.io.Writer, java.lang.Object)">save</A></B>(<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A>&nbsp;xmlDocument,
+     java.io.Writer&nbsp;outputWriter,
+     java.lang.Object&nbsp;options)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serializes an XMLDocument as an XML document into the outputWriter.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<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="INSTANCE"><!-- --></A><H3>
+INSTANCE</H3>
+<PRE>
+static final <A HREF="../../../commonj/sdo/helper/XMLHelper.html" title="interface in commonj.sdo.helper">XMLHelper</A> <B>INSTANCE</B></PRE>
+<DL>
+<DD>The default XMLHelper.
+<P>
+<DL>
+</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="load(java.lang.String)"><!-- --></A><H3>
+load</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> <B>load</B>(java.lang.String&nbsp;inputString)</PRE>
+<DL>
+<DD>Creates and returns an XMLDocument from the input String.
+ By default does not perform XSD validation.
+ Same as
+   load(new StringReader(inputString), null, null);
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>inputString</CODE> - specifies the String to read from
+<DT><B>Returns:</B><DD>the new XMLDocument loaded
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.RuntimeException</CODE> - for errors in XML parsing or 
+   implementation-specific validation.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="load(java.io.InputStream)"><!-- --></A><H3>
+load</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> <B>load</B>(java.io.InputStream&nbsp;inputStream)
+                 throws java.io.IOException</PRE>
+<DL>
+<DD>Creates and returns an XMLDocument from the inputStream.
+ The InputStream will be closed after reading.
+ By default does not perform XSD validation.
+ Same as
+   load(inputStream, null, null);
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - specifies the InputStream to read from
+<DT><B>Returns:</B><DD>the new XMLDocument loaded
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.RuntimeException</CODE> - for errors in XML parsing or 
+   implementation-specific validation.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="load(java.io.InputStream, java.lang.String, java.lang.Object)"><!-- --></A><H3>
+load</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> <B>load</B>(java.io.InputStream&nbsp;inputStream,
+                 java.lang.String&nbsp;locationURI,
+                 java.lang.Object&nbsp;options)
+                 throws java.io.IOException</PRE>
+<DL>
+<DD>Creates and returns an XMLDocument from the inputStream.
+ The InputStream will be closed after reading.
+ By default does not perform XSD validation.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - specifies the InputStream to read from<DD><CODE>locationURI</CODE> - specifies the URI of the document for relative schema locations<DD><CODE>options</CODE> - implementation-specific options.
+<DT><B>Returns:</B><DD>the new XMLDocument loaded
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.RuntimeException</CODE> - for errors in XML parsing or 
+   implementation-specific validation.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="load(java.io.Reader, java.lang.String, java.lang.Object)"><!-- --></A><H3>
+load</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> <B>load</B>(java.io.Reader&nbsp;inputReader,
+                 java.lang.String&nbsp;locationURI,
+                 java.lang.Object&nbsp;options)
+                 throws java.io.IOException</PRE>
+<DL>
+<DD>Creates and returns an XMLDocument from the inputReader.
+ The InputStream will be closed after reading.
+ By default does not perform XSD validation.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>inputReader</CODE> - specifies the Reader to read from<DD><CODE>locationURI</CODE> - specifies the URI of the document for relative schema locations<DD><CODE>options</CODE> - implementation-specific options.
+<DT><B>Returns:</B><DD>the new XMLDocument loaded
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.RuntimeException</CODE> - for errors in XML parsing or 
+   implementation-specific validation.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="save(commonj.sdo.DataObject, java.lang.String, java.lang.String)"><!-- --></A><H3>
+save</H3>
+<PRE>
+java.lang.String <B>save</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+                      java.lang.String&nbsp;rootElementURI,
+                      java.lang.String&nbsp;rootElementName)</PRE>
+<DL>
+<DD>Returns the DataObject saved as an XML document with the specified root element.
+ Same as
+   StringWriter stringWriter = new StringWriter();
+   save(createDocument(dataObject, rootElementURI, rootElementName), 
+     stringWriter, null);
+   stringWriter.toString();
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - specifies DataObject to be saved<DD><CODE>rootElementURI</CODE> - the Target Namespace URI of the root XML element<DD><CODE>rootElementName</CODE> - the Name of the root XML element
+<DT><B>Returns:</B><DD>the saved XML document as a string
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the dataObject tree
+   is not closed or has no container.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="save(commonj.sdo.DataObject, java.lang.String, java.lang.String, java.io.OutputStream)"><!-- --></A><H3>
+save</H3>
+<PRE>
+void <B>save</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+          java.lang.String&nbsp;rootElementURI,
+          java.lang.String&nbsp;rootElementName,
+          java.io.OutputStream&nbsp;outputStream)
+          throws java.io.IOException</PRE>
+<DL>
+<DD>Saves the DataObject as an XML document with the specified root element.
+ Same as
+   save(createDocument(dataObject, rootElementURI, rootElementName),
+     outputStream, null);
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - specifies DataObject to be saved<DD><CODE>rootElementURI</CODE> - the Target Namespace URI of the root XML element<DD><CODE>rootElementName</CODE> - the Name of the root XML element<DD><CODE>outputStream</CODE> - specifies the OutputStream to write to.
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the dataObject tree
+   is not closed or has no container.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="save(commonj.sdo.helper.XMLDocument, java.io.OutputStream, java.lang.Object)"><!-- --></A><H3>
+save</H3>
+<PRE>
+void <B>save</B>(<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A>&nbsp;xmlDocument,
+          java.io.OutputStream&nbsp;outputStream,
+          java.lang.Object&nbsp;options)
+          throws java.io.IOException</PRE>
+<DL>
+<DD>Serializes an XMLDocument as an XML document into the outputStream.
+ If the DataObject's Type was defined by an XSD, the serialization
+   will follow the XSD.
+ Otherwise the serialization will follow the format as if an XSD
+   were generated as defined by the SDO specification.
+ The OutputStream will be flushed after writing.
+ Does not perform validation to ensure compliance with an XSD.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>xmlDocument</CODE> - specifies XMLDocument to be saved<DD><CODE>outputStream</CODE> - specifies the OutputStream to write to.<DD><CODE>options</CODE> - implementation-specific options.
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the dataObject tree
+   is not closed or has no container.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="save(commonj.sdo.helper.XMLDocument, java.io.Writer, java.lang.Object)"><!-- --></A><H3>
+save</H3>
+<PRE>
+void <B>save</B>(<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A>&nbsp;xmlDocument,
+          java.io.Writer&nbsp;outputWriter,
+          java.lang.Object&nbsp;options)
+          throws java.io.IOException</PRE>
+<DL>
+<DD>Serializes an XMLDocument as an XML document into the outputWriter.
+ If the DataObject's Type was defined by an XSD, the serialization
+   will follow the XSD.
+ Otherwise the serialization will follow the format as if an XSD
+   were generated as defined by the SDO specification.
+ The OutputStream will be flushed after writing.
+ Does not perform validation to ensure compliance with an XSD.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>xmlDocument</CODE> - specifies XMLDocument to be saved<DD><CODE>outputWriter</CODE> - specifies the Writer to write to.<DD><CODE>options</CODE> - implementation-specific options.
+<DT><B>Throws:</B>
+<DD><CODE>java.io.IOException</CODE> - for stream exceptions.
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the dataObject tree
+   is not closed or has no container.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="createDocument(commonj.sdo.DataObject, java.lang.String, java.lang.String)"><!-- --></A><H3>
+createDocument</H3>
+<PRE>
+<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> <B>createDocument</B>(<A HREF="../../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A>&nbsp;dataObject,
+                           java.lang.String&nbsp;rootElementURI,
+                           java.lang.String&nbsp;rootElementName)</PRE>
+<DL>
+<DD>Creates an XMLDocument with the specified XML rootElement for the DataObject.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - specifies DataObject to be saved<DD><CODE>rootElementURI</CODE> - the Target Namespace URI of the root XML element<DD><CODE>rootElementName</CODE> - the Name of the root XML element
+<DT><B>Returns:</B><DD>XMLDocument a new XMLDocument set with the specified parameters.</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="class-use/XMLHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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>
+SDO API</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../commonj/sdo/helper/XSDHelper.html" title="interface in commonj.sdo.helper"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?commonj/sdo/helper/XMLHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="XMLHelper.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+-
+</BODY>
+</HTML>



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org