|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.eclipse.persistence.oxm.XMLRoot
org.eclipse.persistence.sdo.SDOXMLDocument
public class SDOXMLDocument
Purpose: Represents an XML Document containing a tree of DataObjects. An example XMLDocument fragment is: <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.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_XML_ENCODING |
static java.lang.String |
DEFAULT_XML_VERSION |
private NamespaceResolver |
namespaceResolver |
private boolean |
xmlDeclaration |
Fields inherited from class org.eclipse.persistence.oxm.XMLRoot |
---|
declaredType, encoding, nil, noNamespaceSchemaLocation, rootFragment, rootObject, schemaLocation, schemaType, xmlVersion |
Constructor Summary | |
---|---|
SDOXMLDocument() |
Method Summary | |
---|---|
java.lang.String |
getEncoding() Return the XML encoding of the document, or null if not specified. |
NamespaceResolver |
getNamespaceResolver() INTERNAL: Return the namespaceResolver to be used with this document. |
java.lang.String |
getNoNamespaceSchemaLocation() 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. |
java.lang.String |
getRootElementName() Return the name of the root element. |
java.lang.String |
getRootElementURI() Return the targetNamespace URI for the root element. |
DataObject |
getRootObject() Return the root DataObject for the XMLDocument. |
java.lang.String |
getSchemaLocation() 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. |
java.lang.String |
getXMLVersion() Return the XML version of the document, or null if not specified. |
boolean |
isXMLDeclaration() Return the XML declaration of the document. |
void |
setEncoding(java.lang.String encoding) Set the XML encoding of the document, or null if not specified. |
void |
setNamespaceResolver(NamespaceResolver namespaceResolver) INTERNAL: Set the namespaceresolver of the document |
void |
setNoNamespaceSchemaLocation(java.lang.String schemaLocation) 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. |
void |
setRootElementName(java.lang.String rootElementName) INTERNAL: Set the root element name of the document |
void |
setRootElementURI(java.lang.String rootElementUri) INTERNAL: Set the root element uri of the document |
void |
setRootObject(DataObject rootObject) INTERNAL: Set the root data object corresponding to the document |
void |
setSchemaLocation(java.lang.String schemaLocation) 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. |
void |
setXMLDeclaration(boolean xmlDeclaration) Set the XML declaration version of the document. |
void |
setXMLVersion(java.lang.String xmlVersion) Set the XML version of the document, or null if not specified. |
Methods inherited from class org.eclipse.persistence.oxm.XMLRoot |
---|
getDeclaredType, getLocalName, getNamespaceURI, getObject, getRootFragment, getSchemaType, isNil, setDeclaredType, setLocalName, setNamespaceURI, setNil, setObject, setSchemaType, setVersion |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_XML_ENCODING
public static final java.lang.String DEFAULT_XML_VERSION
private boolean xmlDeclaration
private NamespaceResolver namespaceResolver
Constructor Detail |
---|
public SDOXMLDocument()
Method Detail |
---|
public DataObject getRootObject()
public java.lang.String getRootElementURI()
public java.lang.String getRootElementName()
public java.lang.String getEncoding()
getEncoding
in class XMLRoot
public void setEncoding(java.lang.String encoding)
setEncoding
in class XMLRoot
encoding
-public boolean isXMLDeclaration()
public void setXMLDeclaration(boolean xmlDeclaration)
xmlDeclaration
- the XML declaration version of the document.public java.lang.String getXMLVersion()
getXMLVersion
in class XMLRoot
public void setXMLVersion(java.lang.String xmlVersion)
xmlVersion
- the XML version of the document, or null if not specified.public java.lang.String getSchemaLocation()
getSchemaLocation
in class XMLRoot
public void setSchemaLocation(java.lang.String schemaLocation)
setSchemaLocation
in class XMLRoot
schemaLocation
- the value of the schemaLocation declaration, or null.public java.lang.String getNoNamespaceSchemaLocation()
getNoNamespaceSchemaLocation
in class XMLRoot
public void setNoNamespaceSchemaLocation(java.lang.String schemaLocation)
setNoNamespaceSchemaLocation
in class XMLRoot
schemaLocation
- the value of the noNamespaceSchemaLocation declaration, or null.public void setRootObject(DataObject rootObject)
rootObject
- the root DataObject corresponding to the documentpublic void setRootElementName(java.lang.String rootElementName)
rootElementName
- the root element name of the documentpublic void setRootElementURI(java.lang.String rootElementUri)
rootElementURI
- the root element uri of the documentpublic void setNamespaceResolver(NamespaceResolver namespaceResolver)
namespaceResolver
- the namespaceResolver to be used with the documentpublic NamespaceResolver getNamespaceResolver()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |