An OracleXmlType object represents an Oracle XMLType instance.
System.Object
System.OracleXmlType
// C# public sealed class OracleXmlType : IDisposable, INullable
| Provider | ODP.NET, Unmanaged Driver | ODP.NET, Managed Driver |
|---|---|---|
| Assembly | Oracle.DataAccess.dll |
Oracle.ManagedDataAccess.dll |
| Namespace | Oracle.DataAccess.Types |
Oracle.ManagedDataAccess.Client |
| .NET Framework | 3.5, 4.0, 4.5 | 4.0, 4.5 |
All public static methods are thread-safe, although instance methods do not guarantee thread safety.
OracleXmlType objects can be used for well-formed XML documents with or without XML schemas or XML fragments.
See Also:
OracleXmlType members are listed in the following tables.
The OracleXmlType constructors are listed in Table 7-19.
Table 7-19 OracleXmlType Constructors
| Constructor | Description |
|---|---|
|
Creates an instance of the |
The OracleXmlType static methods are listed in Table 7-20.
Table 7-20 OracleXmlType Static Methods
| Methods | Description |
|---|---|
|
|
Inherited from |
The OracleXmlType static field is listed in Table 7-21.
Table 7-21 OracleXmlType Static Field
| Static Field | Description |
|---|---|
|
Represents a null value that can be assigned to an |
OracleXmlType Instance Properties
The OracleXmlType instance properties are listed in Table 7-22.
Table 7-22 OracleXmlType Instance Properties
| Properties | Description |
|---|---|
|
Indicates the |
|
|
Indicates whether or not the |
|
|
Indicates whether the XML data is a collection of XML elements or a well-formed XML document |
|
|
Indicates whether or not the |
|
|
Indicates whether or not the XML data represented by the |
|
|
Represents the name of the top-level element of the schema-based XML data contained in the |
|
|
Represents the XML schema of the XML data contained in the |
|
|
Represents in the database for the XML schema of the XML data contained in the |
|
|
Returns the XML data starting from the first character in the current instance as a string |
OracleXmlType Instance Methods
The OracleXmlType instance methods are listed in Table 7-23.
Table 7-23 OracleXmlType Instance Methods
| Methods | Description |
|---|---|
|
Creates a copy of the |
|
|
Releases the resources allocated by this |
|
|
|
Inherited from |
|
Extracts a subset from the XML data using the given XPath expression (Overloaded) |
|
|
|
Inherited from |
|
Returns an instance of |
|
|
|
Inherited from |
|
Returns a |
|
|
Returns a |
|
|
Checks for the existence of a particular set of nodes identified by the given XPath expression in the XMLdata (Overloaded) |
|
|
|
Inherited from |
|
Transforms the |
|
|
Updates the XML node or fragment identified by the given XPath expression in the current |
|
|
Validates whether or not the XML data in the |
OracleXmlType constructors create instances of the OracleXmlType class.
This constructor creates an instance of the OracleXmlType class using the XML data contained in an OracleClob object.
OracleXmlType(OracleConnection, string)
This constructor creates an instance of the OracleXmlType class using the XML data contained in the .NET String.
OracleXmlType(OracleConnection, XmlReader)
This constructor creates an instance of the OracleXmlType class using the contents of the .NET XmlReader object.
OracleXmlType(OracleConnection, XmlDocument)
This constructor creates an instance of the OracleXmlType object using the contents of the XML DOM document in the .NET XmlDocument object.
See Also:
This constructor creates an instance of the OracleXmlType class using the XML data contained in an OracleClob object.
// C#
public OracleXmlType(OracleClob oraClob);
oraClob
An OracleClob object.
ArgumentNullException - The OracleClob object is null.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The CLOB data depends on a valid connection object and the new OracleXMLType uses the OracleConnection in the OracleClob object to store data for the current instance.
This constructor creates an instance of the OracleXmlType class using the XML data contained in the .NET String.
// C# public OracleXmlType(OracleConnection con, string xmlData);
con
An OracleConnection object.
xmlData
A string containing the XML data.
ArgumentNullException - The OracleConnection object is null.
ArgumentException - The xmlData argument is an empty string.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The new OracleXmlType uses the given OracleConnection object to store data for the current instance.
This constructor creates an instance of the OracleXmlType class using the contents of the .NET XmlReader object.
// C# public OracleXmlType(OracleConnection con, XmlReader reader);
con
An OracleConnection object.
reader
An XmlReader object.
ArgumentNullException - The OracleConnection object is null.
ArgumentException - The reader argument contains no data.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The new OracleXMLType uses the given OracleConnection object to store data for the current instance.
This constructor creates an instance of the OracleXmlType object using the contents of the XML DOM document in the .NET XmlDocument object.
// C# public OracleXmlType(OracleConnection con, XmlDocument domDoc);
con
An OracleConnection object.
domDoc
An XML document.
ArgumentNullException - The OracleConnection object is null.
ArgumentException - The domDoc argument contains no data.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The new OracleXMLType uses the given OracleConnection object to store data for the current instance.
The OracleXmlType static methods are listed in Table 7-24.
The OracleXmlType static field is listed in Table 7-25.
Table 7-25 OracleXmlType Static Field
| Static Field | Description |
|---|---|
|
Represents a null value that can be assigned to an |
See Also:
The OracleXmlType instance properties are listed in Table 7-26.
Table 7-26 OracleXmlType Instance Properties
| Properties | Description |
|---|---|
|
Indicates the |
|
|
Indicates whether or not the |
|
|
Indicates whether the XML data is a collection of XML elements or a well-formed XML document |
|
|
Indicates whether or not the |
|
|
Indicates whether or not the XML data represented by the |
|
|
Represents a null value that can be assigned to an |
|
|
Represents the name of the top-level element of the schema-based XML data contained in the |
|
|
Represents the XML schema of the XML data contained in the |
|
|
Represents URL in the database for the XML schema of the XML data contained in the |
|
|
Returns the XML data starting from the first character in the current instance as a string |
See Also:
This property indicates the OracleConnection that is used to retrieve and store XML data in the OracleXmlType.
// C#
public OracleConnection Connection {get;}
An OracleConnection object.
ObjectDisposedException - The object is already disposed.
The connection must explicitly be opened by the user before creating or using OracleXmlType.
This property indicates whether or not the OracleXmlType is empty.
// C#
public bool IsEmpty {get;}
Returns true if the OracleXmlType represents an empty XML document. Returns false otherwise.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This property indicates whether the XML data is a collection of XML elements or a well-formed XML document.
// C#
public bool IsFragment {get;}
Returns true if the XML data contained in the OracleXmlType object is a collection of XML elements with no root element. Returns false otherwise.
ObjectDisposedException - The object is already disposed.
This property indicates whether or not the OracleXmlType is null.
// C#
public bool IsNull {get;}
Returns true if the OracleXmlType represents a null value. Returns false otherwise.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This property indicates whether or not the XML data represented by the OracleXmlType is based on an XML schema.
// C#
public bool IsSchemaBased {get;}
Returns true if the XML data represented by the OracleXmlType is based on an XML schema. Returns false otherwise.
ObjectDisposedException - The object is already disposed.
This property represents the name of the top-level or root element of the schema-based XML data contained in the OracleXmlType.
// C#
public string RootElement{get;}
A string that represents the name of the top-level or root element of the XML data contained in the OracleXmlType.
ObjectDisposedException - The object is already disposed.
If the OracleXmlType instance contains non-schema based XML data, this property returns an empty string.
This property represents the XML schema for the XML data contained in the OracleXmlType.
// C#
public OracleXmlType Schema {get;}
An OracleXmlType instance that represents the XML schema for the XML data contained in the OracleXmlType.
ObjectDisposedException - The object is already disposed.
If the OracleXmlType instance contains non-schema based XML data, this property returns an OracleXmlType instance representing an empty XML document.
This property represents the XML schema in the database for the XML schema of the XML data contained in the OracleXmlType.
// C#
public string SchemaUrl {get;}
A string that represents the URL in the database for the XML schema of the XML data.
ObjectDisposedException - The object is already disposed.
If the OracleXmlType instance contains non-schema based XML data, this property returns an empty string.
This property returns the XML data starting from the first character in the current instance as a string.
// C#
public string Value{get;}
The entire XML data as a string.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The OracleXmlType instance methods are listed in Table 7-27.
Table 7-27 OracleXmlType Instance Methods
| Methods | Description |
|---|---|
|
Creates a copy of the |
|
|
Releases the resources allocated by this |
|
|
|
Inherited from |
|
Extracts a subset from the XML data using the given XPath expression (Overloaded) |
|
|
|
Inherited from |
|
Returns an instance of |
|
|
|
Inherited from |
|
Returns a |
|
|
Returns a |
|
|
Checks for the existence of a particular set of nodes identified by the given XPath expression in the XMLdata (Overloaded) |
|
|
|
Inherited from |
|
Transforms the |
|
|
Updates the XML node or fragment identified by the given XPath expression in the current |
|
|
Validates whether or not the XML data in the |
See Also:
This method creates a copy of this OracleXmlType instance.
// C# public object Clone();
ICloneable
An OracleXmlType object.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This method releases the resources allocated by this object.
// C# public void Dispose();
IDisposable
This method extracts a subset from the XML data using the given XPath expression.
This method extracts a subset from the XML data represented by the OracleXmlType object using the given XPath expression and a string parameter for namespace resolution.
Extract(string, XmlNameSpaceManager)
This method extracts a subset from the XML data represented by the OracleXmlType object, using the given XPath expression and a .NET XmlNameSpaceManager object for namespace resolution.
This method extracts a subset from the XML data represented by the OracleXmlType object using the given XPath expression and a string parameter for namespace resolution.
// C# public OracleXmlType Extract(string xpathExpr, string nsMap);
xpathExpr
The XPath expression.
nsMap
The string parameter used for namespace resolution of the XPath expression. nsMap has zero or more namespaces separated by spaces. nsMap can be null. For example:
xmlns:nsi"=http://www.company1.com" xmlns:nsz="http://www.company2.com"
An OracleXmlType object.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This public method extracts a subset from the XML data represented by the OracleXmlType object, using the given XPath expression and a .NET XmlNameSpaceManager object for namespace resolution.
// C# public OracleXmlType Extract(string xpathExpr, XmlNameSpaceManager nsMgr);
xpathExpr
The XPath expression.
nsMgr
The .NET XmlNameSpaceManager object used for namespace resolution of the XPath expression. nsMgr can be null.
An OracleXmlType.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This public method returns an instance of OracleXmlStream which provides a read-only stream of the XML data stored in this OracleXmlType instance.
// C# public Stream GetStream();
A Stream object.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This public method returns a XmlDocument object containing the XML data stored in this OracleXmlType instance.
// C# public XmlDocument GetXmlDocument();
An XmlDocument object.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The XML data in the XmlDocument object is a copy of the XML data in the OracleXmlType instance and modifying it does not automatically modify the XML data in the OracleXmlType instance. The XmlDocument instance returned has the PreserveWhitespace property set to true.
This public method returns a XmlTextReader object that can be used to manipulate XML data directly using the .NET Framework classes and methods.
// C# public XmlTextReader GetXmlReader();
An XmlTextReader object.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The XmlTextReader is a read-only, forward-only representation of the XML data stored in the OracleXmlType instance.
IsExists checks for the existence of a particular set of nodes identified by the XPath expression in the XML data.
This method checks for the existence of a particular set of nodes identified by the XPath expression in the XML data represented by the current OracleXmlType instance using a string parameter for namespace resolution.
IsExists(string, XmlNameSpaceManager)
This method checks for the existence of a particular set of nodes identified by the XPath expression in the XML document represented by the current OracleXmlType instance using a .NET XmlNameSpaceManager object for namespace resolution.
This method checks for the existence of a particular set of nodes identified by the XPath expression in the XML data represented by the current OracleXmlType instance using a string parameter for namespace resolution.
// C# public bool IsExists(string xpathExpr, string nsMap);
xpathExpr
The XPath expression.
nsMap
The string parameter used for namespace resolution of the XPath expression. nsMap has zero or more namespaces separated by spaces. nsMap can be null.
Returns true if the required set of nodes exists; otherwise, returns false.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This method checks the existence of a particular set of nodes identified by the XPath expression in the XML document represented by the current OracleXmlType instance using a .NET XmlNameSpaceManager object for namespace resolution.
// C# public bool IsExists(string xpathExpr, XmlNameSpaceManager nsMgr);
xpathExpr
The XPath expression.
nsMgr
The .NET XmlNameSpaceManager object used for namespace resolution of the XPath expression. nsMgr can be null.
Returns true if the required set of nodes exists; otherwise, returns false.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This method transforms the OracleXmlType into another OracleXmlType instance using the given XSL document.
Transform(OracleXmlType, string)
This method transforms the current OracleXmlType instance into another OracleXmlType instance using the given XSL document (as an OracleXmlType object) and a string of XSLT parameters.
This public method transforms the current OracleXmlType instance into another OracleXmlType instance using the given XSL document and a string of XSLT parameters.
This method transforms the current OracleXmlType instance into another OracleXmlType instance using the given XSL document and a string of XSLT parameters.
// C# public OracleXmlType Transform(OracleXmlType xsldoc, string paramMap);
xsldoc
The XSL document as an OracleXmlType object.
paramMap
A string which provides the parameters for the XSL document.
For this release, paramMap is ignored.
An OracleXmlType object containing the transformed XML document.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xsldoc parameter is null.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This method transforms the current OracleXmlType instance into another OracleXmlType instance using the given XSL document and a string of XSLT parameters.
// C# public OracleXmlType Transform(string xsldoc, string paramMap);
xsldoc
The XSL document to be used for XSLT.
paramMap
A string which provides the parameters for the XSL document.
For this release, paramMap is ignored.
An OracleXmlType object containing the transformed XML document.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xsldoc parameter is null.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
This method updates the XML node or fragment identified by the given XPath expression in the current OracleXmlType instance.
Update(string, string, string)
This method updates the XML nodes identified by the given XPath expression with the given string value and a string parameter for namespace resolution.
Update(string, XmlNameSpaceManager, string)
This method updates the XML nodes identified by the given XPath expression with the given string value and a .NET XmlNameSpaceManager object for namespace resolution.
Update(string, string, OracleXmlType)
This method updates the XML nodes identified by the given XPath expression with the XML data stored in the given OracleXmlType value and a string parameter for namespace resolution.
Update(string, XmlNameSpaceManager, OracleXmlType)
This method updates the XML nodes identified by the given XPath expression with the XML data stored in the given OracleXmlType value and a .NET XmlNameSpaceManager object for namespace resolution.
This method updates the XML nodes identified by the given XPath expression with the given string value and a string parameter for namespace resolution.
// C# public void Update(string xpathExpr, string nsMap, string value);
xpathExpr
The XPath expression that identifies the nodes to update.
nsMap
The string parameter used for namespace resolution of the XPath expression. nsMap has zero or more namespaces separated by spaces. nsMap can be null. For example:
xmlns:nsi"=http://www.company1.com" xmlns:nsz="http://www.company2.com"
value
The new value as a string.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This method updates the XML nodes identified by the given XPath expression with the given string value and a .NET XmlNameSpaceManager object for namespace resolution.
// C# public void Update(string xpathExpr, XmlNameSpaceManager nsMgr, string value);
xpathExpr
The XPath expression that identifies the nodes to update.
nsMgr
The .NET XmlNameSpaceManager object used for namespace resolution of the XPath expression. nsMgr can be null.
value
The new value as a string.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This method updates the XML nodes identified by the given XPath expression with the XML data stored in the given OracleXmlType value and a string parameter for namespace resolution.
// C# public void Update(string xpathExpr, string nsMap, OracleXmlType value);
xpathExpr
The XPath expression that identifies the nodes to update.
nsMap
The string parameter used for namespace resolution of the XPath expression. nsMap has zero or more namespaces separated by spaces. nsMap can be null.
value
The new value as an OracleXmlType object.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This method updates the XML nodes identified by the given XPath expression with the XML data stored in the given OracleXmlType value and a .NET XmlNameSpaceManager object for namespace resolution.
// C# public void Update(string xpathExpr, XmlNameSpaceManager nsMgr, OracleXmlType value);
xpathExpr
The XPath expression that identifies the nodes to update.
nsMgr
The .NET XmlNameSpaceManager object used for namespace resolution of the XPath expression. nsMgr can be null.
value
The new value as an OracleXmlType object.
ObjectDisposedException - The object is already disposed.
ArgumentNullException - The xpathExpr is null or zero-length.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
The default namespace is ignored if its value is an empty string.
This methods validates whether or not the XML data in the OracleXmlType object conforms to the given XML schema.
// C# public bool Validate(String schemaUrl);
schemaUrl
A string representing the URL in the database of the XML schema.
Returns true if the XML data conforms to the XML schema; otherwise, returns false.
ObjectDisposedException - The object is already disposed.
InvalidOperationException - The OracleConnection is not open or has been closed during the lifetime of the object.
ArgumentNullException - The schemaUrl argument is null or an empty string.