bdd0a41aed
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@668359 13f79535-47bb-0310-9956-ffa450edef68
593 lines
28 KiB
HTML
593 lines
28 KiB
HTML
<!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) on Wed Dec 05 13:51:40 GMT 2007 -->
|
|
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<TITLE>
|
|
XMLHelper (com.agfa.hap.sdo 2.15.0-for-apache-SNAPSHOT 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 (com.agfa.hap.sdo 2.15.0-for-apache-SNAPSHOT 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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>
|
|
<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>
|
|
<A HREF="XMLHelper.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<A NAME="main"></A>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
commonj.sdo.helper</FONT>
|
|
<BR>
|
|
Interface XMLHelper</H2>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/agfa/hap/sdo/implementation/XMLHelperImpl.html" title="class in com.agfa.hap.sdo.implementation">XMLHelperImpl</A></DD>
|
|
</DL>
|
|
<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 <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>
|
|
The default XMLHelper.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String rootElementName)</CODE>
|
|
|
|
<BR>
|
|
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> <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 inputStream)</CODE>
|
|
|
|
<BR>
|
|
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> <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 inputStream,
|
|
java.lang.String locationURI,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
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> <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 inputReader,
|
|
java.lang.String locationURI,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
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> <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(javax.xml.transform.Source, java.lang.String, java.lang.Object)">load</A></B>(javax.xml.transform.Source inputSource,
|
|
java.lang.String locationURI,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
Creates and returns an XMLDocument from the inputSource.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <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 inputString)</CODE>
|
|
|
|
<BR>
|
|
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> 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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String rootElementName)</CODE>
|
|
|
|
<BR>
|
|
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> 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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String rootElementName,
|
|
java.io.OutputStream outputStream)</CODE>
|
|
|
|
<BR>
|
|
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> 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> xmlDocument,
|
|
java.io.OutputStream outputStream,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
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> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../commonj/sdo/helper/XMLHelper.html#save(commonj.sdo.helper.XMLDocument, javax.xml.transform.Result, java.lang.Object)">save</A></B>(<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper">XMLDocument</A> xmlDocument,
|
|
javax.xml.transform.Result outputResult,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
Serializes an XMLDocument as an XML document into the outputResult in a
|
|
serialization technology independent format (as specified in
|
|
javax.xml.transform).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> 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> xmlDocument,
|
|
java.io.Writer outputWriter,
|
|
java.lang.Object options)</CODE>
|
|
|
|
<BR>
|
|
Serializes an XMLDocument as an XML document into the outputWriter.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="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 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 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 inputStream,
|
|
java.lang.String locationURI,
|
|
java.lang.Object 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 inputReader,
|
|
java.lang.String locationURI,
|
|
java.lang.Object 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="load(javax.xml.transform.Source, 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>(javax.xml.transform.Source inputSource,
|
|
java.lang.String locationURI,
|
|
java.lang.Object options)
|
|
throws java.io.IOException</PRE>
|
|
<DL>
|
|
<DD>Creates and returns an XMLDocument from the inputSource.
|
|
The InputSource will be closed after reading.
|
|
By default does not perform XSD validation.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>inputSource</CODE> - specifies the Source 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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String 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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String rootElementName,
|
|
java.io.OutputStream 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> xmlDocument,
|
|
java.io.OutputStream outputStream,
|
|
java.lang.Object 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> xmlDocument,
|
|
java.io.Writer outputWriter,
|
|
java.lang.Object 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="save(commonj.sdo.helper.XMLDocument, javax.xml.transform.Result, 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> xmlDocument,
|
|
javax.xml.transform.Result outputResult,
|
|
java.lang.Object options)
|
|
throws java.io.IOException</PRE>
|
|
<DL>
|
|
<DD>Serializes an XMLDocument as an XML document into the outputResult in a
|
|
serialization technology independent format (as specified in
|
|
javax.xml.transform).
|
|
The OutputResult 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>outputResult</CODE> - specifies Result to be saved<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> dataObject,
|
|
java.lang.String rootElementURI,
|
|
java.lang.String 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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../commonj/sdo/helper/XMLDocument.html" title="interface in commonj.sdo.helper"><B>PREV CLASS</B></A>
|
|
<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>
|
|
<A HREF="XMLHelper.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2007. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|