| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:48 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SDOXMLDocument (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SDOXMLDocument (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/sdo/SDOType.TypeInstantiationPolicy.html" title="class in org.eclipse.persistence.sdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html" title="interface in org.eclipse.persistence.sdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/sdo/SDOXMLDocument.html" target="_top">Frames</a></li> |
| <li><a href="SDOXMLDocument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.sdo</div> |
| <h2 title="Class SDOXMLDocument" class="title">Class SDOXMLDocument</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.internal.oxm.Root</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/persistence/oxm/XMLRoot.html" title="class in org.eclipse.persistence.oxm">org.eclipse.persistence.oxm.XMLRoot</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.sdo.SDOXMLDocument</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>commonj.sdo.helper.XMLDocument</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SDOXMLDocument</span> |
| extends <a href="../../../../org/eclipse/persistence/oxm/XMLRoot.html" title="class in org.eclipse.persistence.oxm">XMLRoot</a> |
| implements commonj.sdo.helper.XMLDocument</pre> |
| <div class="block"><p><b>Purpose</b>: Represents an XML Document containing a tree of DataObjects. |
| |
| <p>An example XMLDocument fragment is:<br> |
| <?xml version="1.0"?><br> |
| <purchaseOrder orderDate="1999-10-20"> |
| |
| <p>created from this XML Schema fragment:<br> |
| <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"><br> |
| <xsd:element name="purchaseOrder" type="PurchaseOrderType"/><br> |
| <xsd:complexType name="PurchaseOrderType"> |
| |
| <p>Upon loading this XMLDocument:<br> |
| DataObject is an instance of Type PurchaseOrderType.<br> |
| RootElementURI is null because the XSD has no targetNamespace URI.<br> |
| RootElementName is purchaseOrder.<br> |
| Encoding is null because the document did not specify an encoding.<br> |
| XMLDeclaration is true because the document contained an XML declaration.<br> |
| XMLVersion is 1.0<br> |
| SchemaLocation and noNamespaceSchemaLocation are null because they are |
| not specified in the document. |
| |
| <p>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. |
| |
| <p>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.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#DEFAULT_XML_ENCODING">DEFAULT_XML_ENCODING</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#DEFAULT_XML_VERSION">DEFAULT_XML_VERSION</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.internal.oxm.Root"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.internal.oxm.Root</h3> |
| <code>declaredType, encoding, localName, namespaceUri, nil, noNamespaceSchemaLocation, prefix, rootObject, schemaLocation, schemaType, xmlVersion</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#SDOXMLDocument--">SDOXMLDocument</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getEncoding--">getEncoding</a></span>()</code> |
| <div class="block">Return the XML encoding of the document, or null if not specified.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/oxm/NamespaceResolver.html" title="class in org.eclipse.persistence.oxm">NamespaceResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getNamespaceResolver--">getNamespaceResolver</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the namespaceResolver to be used with this document.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getNoNamespaceSchemaLocation--">getNoNamespaceSchemaLocation</a></span>()</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getRootElementName--">getRootElementName</a></span>()</code> |
| <div class="block">Return the name of the root element.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getRootElementURI--">getRootElementURI</a></span>()</code> |
| <div class="block">Return the targetNamespace URI for the root element.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>commonj.sdo.DataObject</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getRootObject--">getRootObject</a></span>()</code> |
| <div class="block">Return the root DataObject for the XMLDocument.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getSchemaLocation--">getSchemaLocation</a></span>()</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#getXMLVersion--">getXMLVersion</a></span>()</code> |
| <div class="block">Return the XML version of the document, or null if not specified.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#isXMLDeclaration--">isXMLDeclaration</a></span>()</code> |
| <div class="block">Return the XML declaration of the document.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setEncoding-java.lang.String-">setEncoding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Set the XML encoding of the document, or null if not specified.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setNamespaceResolver-org.eclipse.persistence.oxm.NamespaceResolver-">setNamespaceResolver</a></span>(<a href="../../../../org/eclipse/persistence/oxm/NamespaceResolver.html" title="class in org.eclipse.persistence.oxm">NamespaceResolver</a> namespaceResolver)</code> |
| <div class="block">INTERNAL: |
| Set the namespaceresolver of the document</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setNoNamespaceSchemaLocation-java.lang.String-">setNoNamespaceSchemaLocation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaLocation)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setRootElementName-java.lang.String-">setRootElementName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootElementName)</code> |
| <div class="block">INTERNAL: |
| Set the root element name of the document</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setRootElementURI-java.lang.String-">setRootElementURI</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootElementUri)</code> |
| <div class="block">INTERNAL: |
| Set the root element uri of the document</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setRootObject-commonj.sdo.DataObject-">setRootObject</a></span>(commonj.sdo.DataObject rootObject)</code> |
| <div class="block">INTERNAL: |
| Set the root data object corresponding to the document</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setSchemaLocation-java.lang.String-">setSchemaLocation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaLocation)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setXMLDeclaration-boolean-">setXMLDeclaration</a></span>(boolean xmlDeclaration)</code> |
| <div class="block">Set the XML declaration version of the document.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html#setXMLVersion-java.lang.String-">setXMLVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> xmlVersion)</code> |
| <div class="block">Set the XML version of the document, or null if not specified.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.oxm.Root"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.internal.oxm.Root</h3> |
| <code>equals, getDeclaredType, getLocalName, getNamespaceURI, getObject, getSchemaType, hashCode, isNil, setDeclaredType, setLocalName, setNamespaceURI, setNil, setObject, setSchemaType, setVersion</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_XML_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_XML_ENCODING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_XML_ENCODING</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.sdo.SDOXMLDocument.DEFAULT_XML_ENCODING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_XML_VERSION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_XML_VERSION</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_XML_VERSION</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.sdo.SDOXMLDocument.DEFAULT_XML_VERSION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SDOXMLDocument--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SDOXMLDocument</h4> |
| <pre>public SDOXMLDocument()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRootObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootObject</h4> |
| <pre>public commonj.sdo.DataObject getRootObject()</pre> |
| <div class="block">Return the root DataObject for the XMLDocument.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getRootObject</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>root DataObject for the XMLDocument.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRootElementURI--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootElementURI</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRootElementURI()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getRootElementURI</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the targetNamespace URI for the root element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRootElementName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootElementName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRootElementName()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getRootElementName</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the root element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEncoding()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getEncoding</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getEncoding</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the XML encoding of the document, or null if not specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre>public void setEncoding(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</pre> |
| <div class="block">Set the XML encoding of the document, or null if not specified.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setEncoding</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setEncoding</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isXMLDeclaration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isXMLDeclaration</h4> |
| <pre>public boolean isXMLDeclaration()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isXMLDeclaration</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the XML declaration of the document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setXMLDeclaration-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXMLDeclaration</h4> |
| <pre>public void setXMLDeclaration(boolean xmlDeclaration)</pre> |
| <div class="block">Set the XML declaration version of the document.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setXMLDeclaration</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xmlDeclaration</code> - the XML declaration version of the document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXMLVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLVersion</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getXMLVersion()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getXMLVersion</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getXMLVersion</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the XML version of the document, or null if not specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setXMLVersion-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXMLVersion</h4> |
| <pre>public void setXMLVersion(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> xmlVersion)</pre> |
| <div class="block">Set the XML version of the document, or null if not specified.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setXMLVersion</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xmlVersion</code> - the XML version of the document, or null if not specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaLocation</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSchemaLocation()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getSchemaLocation</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getSchemaLocation</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the schemaLocation declaration, |
| or null if not present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchemaLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaLocation</h4> |
| <pre>public void setSchemaLocation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaLocation)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setSchemaLocation</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setSchemaLocation</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schemaLocation</code> - the value of the schemaLocation declaration, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNoNamespaceSchemaLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNoNamespaceSchemaLocation</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNoNamespaceSchemaLocation()</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getNoNamespaceSchemaLocation</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getNoNamespaceSchemaLocation</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the noNamespaceSchemaLocation declaration, |
| or null if not present.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNoNamespaceSchemaLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoNamespaceSchemaLocation</h4> |
| <pre>public void setNoNamespaceSchemaLocation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaLocation)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setNoNamespaceSchemaLocation</code> in interface <code>commonj.sdo.helper.XMLDocument</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>setNoNamespaceSchemaLocation</code> in class <code>org.eclipse.persistence.internal.oxm.Root</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schemaLocation</code> - the value of the noNamespaceSchemaLocation declaration, or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRootObject-commonj.sdo.DataObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootObject</h4> |
| <pre>public void setRootObject(commonj.sdo.DataObject rootObject)</pre> |
| <div class="block">INTERNAL: |
| Set the root data object corresponding to the document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootObject</code> - the root DataObject corresponding to the document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRootElementName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootElementName</h4> |
| <pre>public void setRootElementName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootElementName)</pre> |
| <div class="block">INTERNAL: |
| Set the root element name of the document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootElementName</code> - the root element name of the document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRootElementURI-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRootElementURI</h4> |
| <pre>public void setRootElementURI(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootElementUri)</pre> |
| <div class="block">INTERNAL: |
| Set the root element uri of the document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootElementUri</code> - the root element uri of the document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNamespaceResolver-org.eclipse.persistence.oxm.NamespaceResolver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNamespaceResolver</h4> |
| <pre>public void setNamespaceResolver(<a href="../../../../org/eclipse/persistence/oxm/NamespaceResolver.html" title="class in org.eclipse.persistence.oxm">NamespaceResolver</a> namespaceResolver)</pre> |
| <div class="block">INTERNAL: |
| Set the namespaceresolver of the document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespaceResolver</code> - the namespaceResolver to be used with the document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespaceResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNamespaceResolver</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/oxm/NamespaceResolver.html" title="class in org.eclipse.persistence.oxm">NamespaceResolver</a> getNamespaceResolver()</pre> |
| <div class="block">INTERNAL: |
| Return the namespaceResolver to be used with this document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the namespaceResolver being used with this document</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/sdo/SDOType.TypeInstantiationPolicy.html" title="class in org.eclipse.persistence.sdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html" title="interface in org.eclipse.persistence.sdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/sdo/SDOXMLDocument.html" target="_top">Frames</a></li> |
| <li><a href="SDOXMLDocument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
