ヘッダーをスキップ
Oracle Data Provider for .NET開発者ガイド
11g リリース1(11.1)
E05791-01
  目次へ
目次
索引へ
索引

戻る
戻る
 
次へ
次へ
 

OracleXmlTypeクラス

OracleXmlTypeオブジェクトは、Oracle XMLTypeインスタンスを表します。

クラスの継承

System.Object

  System.OracleXmlType

宣言

// C#
public sealed class OracleXmlType : IDisposable, INullable

スレッド安全性

パブリック静的メソッドはスレッドセーフですが、インスタンス・メソッドではスレッド安全性は保証されません。

備考

OracleXmlTypeオブジェクトは、XML SchemaまたはXML断片部分があるかどうかにかかわらず、整形式XML文書に使用できます。

要件

ネームスペース: Oracle.DataAccess.Types

アセンブリ: Oracle.DataAccess.dll

Microsoft .NET Frameworkバージョン: 1.xまたは2.0

このクラスは、Oracle9iリリース2(9.2)以上でのみ使用できます。


OracleXmlTypeメンバー

OracleXmlTypeメンバーを次の表にリストします。

OracleXmlTypeコンストラクタ

OracleXmlTypeコンストラクタのリストを、表6-19に示します。

表6-19 OracleXmlTypeコンストラクタ

コンストラクタ 説明

OracleXmlTypeコンストラクタ

OracleXmlTypeクラスのインスタンスを作成します(オーバーロード)


OracleXmlType静的メソッド

OracleXmlType静的メソッドのリストを、表6-20に示します。

表6-20 OracleXmlType静的メソッド

メソッド 説明

Equals

System.Objectからの継承(オーバーロード)


OracleXmlTypeインスタンス・プロパティ

OracleXmlTypeインスタンス・プロパティのリストを、表6-21に示します。

表6-21 OracleXmlTypeインスタンス・プロパティ

プロパティ 説明

Connection

XMLデータをOracleXmlTypeから取得したり、そこに格納する場合に使用するOracleConnectionを示します

IsEmpty

OracleXmlTypeが空であるかどうかを示します

IsFragment

XMLデータがXML要素の集合または整形式のXML文書であるかどうかを示します

IsSchemaBased

OracleXmlTypeによって表されるXMLデータがXMLスキーマに基づくかどうかを示します

RootElement


OracleXmlTypeに含まれるスキーマに基づくXMLデータの最上位レベル要素の名前を表します

Schema


OracleXmlTypeに含まれるXMLデータのXMLスキーマを表します

SchemaUrl


OracleXmlTypeに含まれるXMLデータのXMLスキーマへのデータベース内のURLを表します

Value


現行インスタンス内の最初の文字が文字列であるXMLデータを戻します


OracleXmlTypeインスタンス・メソッド

OracleXmlTypeインスタンス・メソッドのリストを、表6-22に示します。

表6-22 OracleXmlTypeインスタンス・メソッド

メソッド 説明

Clone

OracleXmlTypeインスタンスのコピーを作成します

Dispose

このOracleXmlTypeオブジェクトによって割り当てられたリソースを解除します

Equals

System.Objectからの継承

Extract

指定されたXPath式を使用してXMLデータからサブセットを抽出します(オーバーロード)

GetHashCode

System.Objectからの継承

GetStream

このOracleXmlTypeインスタンス内に格納されているXMLデータの読取り専用ストリームを提供するOracleXmlStreamのインスタンスを戻します

GetType

System.Objectからの継承

GetXmlDocument

このOracleXmlTypeインスタンス内に格納されているXMLデータに含まれているXmlDocumentオブジェクトを戻します

GetXmlReader

.NETフレームワークのクラスおよびメソッドを使用してXMLデータを直接操作するために使用できるXmlTextReaderオブジェクトを戻します

IsExists

XMLデータ内で指定したXPath式によって識別される特定のノードのセットが存在するかどうかを確認します(オーバーロード)

ToString

System.Objectからの継承

Transform

指定されたXSL文書を使用してOracleXmlTypeを別のOracleXmlTypeインスタンスに変換します(オーバーロード)

Update

現行のOracleXmlTypeインスタンス内でXMLノードまたは断片を指定されたXPath式で更新します(オーバーロード)

Validate


OracleXmlTypeオブジェクト内のXMLデータが指定されたXMLスキーマに準拠しているかどうかを検証します



OracleXmlTypeコンストラクタ

OracleXmlTypeコンストラクタは、OracleXmlTypeクラスのインスタンスを作成します。

オーバーロード・リスト:

OracleXmlType(OracleClob)

このコンストラクタは、OracleClobオブジェクト内に含まれているXMLデータを使用して、OracleXmlTypeクラスのインスタンスを作成します。

宣言

// C#
public OracleXmlType(OracleClob oraClob);

パラメータ

例外

ArgumentNullException: OracleClobオブジェクトはNULLです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

CLOBデータは有効な接続オブジェクトに依存し、新規のOracleXMLTypeは、現行インスタンスのデータの格納にOracleClobオブジェクト内のOracleConnectionを使用します。

OracleXmlType(OracleConnection, string)

このコンストラクタは、.NET String内に含まれているXMLデータを使用して、OracleXmlTypeクラスのインスタンスを作成します。

宣言

// C#
public OracleXmlType(OracleConnection con, string xmlData);

パラメータ

例外

ArgumentNullException: OracleConnectionオブジェクトはNULLです。

ArgumentException: xmlData引数は空の文字列です。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

新規OracleXmlTypeは、現行インスタンスのデータの格納に指定されたOracleConnectionオブジェクトを使用します。

OracleXmlType(OracleConnection, XmlReader)

このコンストラクタは、.NET XmlReaderオブジェクトのコンテンツを使用して、OracleXmlTypeクラスのインスタンスを作成します。

宣言

// C#
public OracleXmlType(OracleConnection con, XmlReader reader);

パラメータ

例外

ArgumentNullException: OracleConnectionオブジェクトはNULLです。

ArgumentException: reader引数にはデータは含まれません。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

新規OracleXMLTypeは、現行インスタンスのデータの格納に指定されたOracleConnectionオブジェクトを使用します。

OracleXmlType(OracleConnection, XmlDocument)

このコンストラクタは、.NET XmlDocumentオブジェクト内のXML DOM文書のコンテンツを使用して、OracleXmlTypeオブジェクトのインスタンスを作成します。

宣言

// C#
public OracleXmlType(OracleConnection con, XmlDocument domDoc);

パラメータ

例外

ArgumentNullException: OracleConnectionオブジェクトはNULLです。

ArgumentException: domDoc引数にはデータは含まれません。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

新規OracleXMLTypeは、現行インスタンスのデータの格納に指定されたOracleConnectionオブジェクトを使用します。


OracleXmlType静的メソッド

OracleXmlType静的メソッドのリストを、表6-23に示します。

表6-23 OracleXmlType静的メソッド

メソッド 説明

Equals

System.Objectからの継承(オーバーロード)



OracleXmlTypeインスタンス・プロパティ

OracleXmlTypeインスタンス・プロパティのリストを、表6-24に示します。

表6-24 OracleXmlTypeインスタンス・プロパティ

プロパティ 説明

Connection


XMLデータをOracleXmlTypeから取得したり、そこに格納する場合に使用するOracleConnectionを示します

IsEmpty


OracleXmlTypeが空であるかどうかを示します

IsFragment


XMLデータがXML要素の集合または整形式のXML文書であるかどうかを示します

IsSchemaBased


OracleXmlTypeによって表されるXMLデータがXMLスキーマに基づくかどうかを示します

RootElement


OracleXmlTypeに含まれるスキーマに基づくXMLデータの最上位レベル要素の名前を表します

Schema


OracleXmlTypeに含まれるXMLデータのXMLスキーマを表します

SchemaUrl


OracleXmlTypeに含まれるXMLデータのXMLスキーマへのデータベース内のURLを表します

Value


現行インスタンス内の最初の文字が文字列であるXMLデータを戻します


Connection

このプロパティは、XMLデータをOracleXmlTypeから取得したり、そこに格納したりするために使用されるOracleConnectionを示します。

宣言

// C#
public OracleConnection Connection {get;}

プロパティ値

OracleConnectionオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

備考

ユーザーは、OracleXmlTypeの作成または使用前に接続を明示的にオープンする必要があります。

IsEmpty

このプロパティは、OracleXmlTypeが空であるかどうかを示します。

宣言

// C#
public bool IsEmpty {get;}

プロパティ値

OracleXmlTypeが空のXML文書を表す場合は、trueを戻します。それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

IsFragment

このプロパティは、XMLデータがXML要素の集合または整形式のXML文書であるかどうかを示します。

宣言

// C#
public bool IsFragment {get;}

プロパティ値

OracleXmlTypeオブジェクトに含まれているXMLデータが、ルート要素のないXML要素の集合である場合は、trueを戻します。それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

IsSchemaBased

このプロパティは、OracleXmlTypeによって表されるXMLデータがXMLスキーマに基づくかどうかを示します。

宣言

// C#
public bool IsSchemaBased {get;}

プロパティ値

OracleXmlTypeによって表されるXMLデータがXMLスキーマに基づく場合は、trueを戻します。それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

RootElement

このプロパティは、OracleXmlTypeに含まれるスキーマに基づくXMLデータの最上位レベルまたはルート要素の名前を表します。

宣言

// C#
public string RootElement{get;}

プロパティ値

OracleXmlTypeに含まれるXMLデータの最上位レベルまたはルート要素の名前を表す文字列です。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

備考

OracleXmlTypeインスタンスに非スキーマ・ベースのXMLデータが含まれる場合、このプロパティは空の文字列を戻します。

Schema

このプロパティは、OracleXmlTypeに含まれるXMLデータのXMLスキーマを表します。

宣言

// C#
public OracleXmlType Schema {get;}

プロパティ値

OracleXmlTypeに含まれるXMLデータのXMLスキーマを表すOracleXmlTypeインスタンスです。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

備考

OracleXmlTypeインスタンスに非スキーマ・ベースのXMLデータが含まれる場合、このプロパティは空のXML文書を表すOracleXmlTypeインスタンスを戻します。

SchemaUrl

このプロパティは、OracleXmlTypeに含まれるXMLデータのXMLスキーマへのデータベース内のURLを表します。

宣言

// C#
public string SchemaUrl {get;}

プロパティ値

XMLデータのXMLスキーマへのデータベース内のURLを表す文字列です。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

備考

OracleXmlTypeインスタンスに非スキーマ・ベースのXMLデータが含まれる場合、このプロパティは空の文字列を戻します。

Value

このプロパティは、現行インスタンス内のXMLデータを最初の文字からstringとして戻します。

宣言

// C#
public string RootElement{get;}

プロパティ値

stringとしてのXMLデータ全体

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。


OracleXmlTypeインスタンス・メソッド

OracleXmlTypeインスタンス・メソッドのリストを、表6-25に示します。

表6-25 OracleXmlTypeインスタンス・メソッド

メソッド 説明

Clone

OracleXmlTypeインスタンスのコピーを作成します

Dispose

このOracleXmlTypeオブジェクトによって割り当てられたリソースを解除します

Equals

System.Objectからの継承

Extract

指定されたXPath式を使用してXMLデータからサブセットを抽出します(オーバーロード)

GetHashCode

System.Objectからの継承

GetStream

このOracleXmlTypeインスタンス内に格納されているXMLデータの読取り専用ストリームを提供するOracleXmlStreamのインスタンスを戻します

GetType

System.Objectからの継承

GetXmlDocument

このOracleXmlTypeインスタンス内に格納されているXMLデータに含まれているXmlDocumentオブジェクトを戻します

GetXmlReader

.NETフレームワークのクラスおよびメソッドを使用してXMLデータを直接操作するために使用できるXmlTextReaderオブジェクトを戻します

IsExists

XMLデータ内で指定したXPath式によって識別される特定のノードのセットが存在するかどうかを確認します(オーバーロード)

ToString

System.Objectからの継承

Transform

指定されたXSL文書を使用してOracleXmlTypeを別のOracleXmlTypeインスタンスに変換します(オーバーロード)

Update

現行のOracleXmlTypeインスタンス内でXMLノードまたは断片を指定されたXPath式で更新します(オーバーロード)

Validate


OracleXmlTypeオブジェクト内のXMLデータが指定されたXMLスキーマに準拠しているかどうかを検証します


Clone

このメソッドは、このOracleXmlTypeインスタンスのコピーを作成します。

宣言

// C#
public object Clone();

実装

ICloneable

戻り値

OracleXmlTypeオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

Dispose

このメソッドは、このオブジェクトによって割り当てられたリソースを解除します。

宣言

// C#
public void Dispose();

実装

IDisposable

Extract

このメソッドは、指定されたXPath式を使用してXMLデータからサブセットを抽出します。

オーバーロード・リスト:

Extract(string, string)

このメソッドは、ネームスペース解決用の指定されたXPath式および文字列パラメータを使用して、OracleXmlTypeオブジェクトによって表されたXMLデータからサブセットを抽出します。

宣言

// C#
public OracleXmlType Extract(string xpathExpr, string nsMap);

パラメータ

戻り値

OracleXmlTypeオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

Extract(string, XmlNameSpaceManager)

このパブリック・メソッドはネームスペース解決用の指定されたXPath式および.NET XmlNameSpaceManagerオブジェクトを使用して、OracleXmlTypeオブジェクトによって表されたXMLデータからサブセットを抽出します。

宣言

// C#
public OracleXmlType Extract(string xpathExpr, XmlNameSpaceManager nsMgr);

パラメータ

戻り値

OracleXmlType

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

GetStream

このパブリック・メソッドは、このOracleXmlTypeインスタンス内に格納されている、XMLデータの読取り専用ストリームを提供するOracleXmlStreamのインスタンスを戻します。

宣言

// C#
public Stream GetStream();

戻り値

Streamオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

GetXmlDocument

このパブリック・メソッドは、このOracleXmlTypeインスタンス内に格納されている、XMLデータに含まれているXmlDocumentオブジェクトを戻します。

宣言

// C#
public XmlDocument GetXmlDocument();

戻り値

XmlDocumentオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

XmlDocumentオブジェクト内のXMLデータは、OracleXmlTypeインスタンス内のXMLデータのコピーのため、変更してもOracleXmlTypeインスタンス内のXMLデータは自動的に変更されません。戻されたXmlDocumentインスタンスにより、PreserveWhitespaceプロパティはtrueに設定されます。

GetXmlReader

このパブリック・メソッドは、.NETフレームワークのクラスおよびメソッドを使用して、XMLデータを直接操作する場合に使用可能なXmlTextReaderオブジェクトを戻します。

宣言

// C#
public XmlTextReader GetXmlReader();

戻り値

XmlTextReaderオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

XmlTextReaderは、OracleXmlTypeインスタンスに格納されているXMLデータを読取り専用、順方向専用で表したものです。

IsExists

IsExistsは、XMLデータ内でXPath式によって識別される特定のノードのセットが存在するかどうかを確認します。

オーバーロード・リスト:

IsExists(string, string)

このメソッドはネームスペース解決用の文字列パラメータを使用して、現行のOracleXmlTypeインスタンスによって表されるXMLデータ内でXPath式によって識別される特定のノードのセットが存在するかどうかを確認します。

宣言

// C#
public bool IsExists(string xpathExpr, string nsMap);

パラメータ

戻り値

対象のノードのセットが存在する場合はtrueを戻し、それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

IsExists(string, XmlNameSpaceManager)

このメソッドはネームスペース解決用の.NET XmlNameSpaceManagerオブジェクトを使用して、現行のOracleXmlTypeインスタンスによって表されるXML文書内でXPath式によって識別される、特定のノードのセットが存在するかどうかを確認します。

宣言

// C#
public bool IsExists(string xpathExpr, XmlNameSpaceManager nsMgr);

パラメータ

戻り値

対象のノードのセットが存在する場合はtrueを戻し、それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

Transform

このメソッドは、指定されたXSL文書を使用してOracleXmlTypeを別のOracleXmlTypeインスタンスに変換します。

オーバーロード・リスト:

Transform(OracleXmlType, string)

このメソッドは指定されたXSL文書とXSLTパラメータの文字列を使用して、現行のOracleXmlTypeインスタンスを別のOracleXmlTypeインスタンスに変換します。

宣言

// C#
public OracleXmlType Transform(OracleXmlType xsldoc, string paramMap);

パラメータ

戻り値

変換されたXML文書を含むOracleXmlTypeオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xsldocパラメータがNULLです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

Transform(string, string)

このメソッドは指定されたXSL文書とXSLTパラメータの文字列を使用して、現行のOracleXmlTypeインスタンスを別のOracleXmlTypeインスタンスに変換します。

宣言

// C#
public OracleXmlType Transform(string xsldoc, string paramMap);

パラメータ

戻り値

変換されたXML文書を含むOracleXmlTypeオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xsldocパラメータがNULLです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

Update

このメソッドは、現行のOracleXmlTypeインスタンス内で指定されたXPath式によって識別される、XMLノードまたは断片を更新します。

オーバーロード・リスト:

Update(string, string, string)

このメソッドは、ネームスペース解決用の指定された文字列値と文字列パラメータを使用して、指定されたXPath式によって識別されるXMLノードを更新します。

宣言

// C#
public void Update(string xpathExpr, string nsMap, string value);

パラメータ

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

Update(string, XmlNameSpaceManager, string)

このメソッドは、ネームスペース解決用の指定された文字列値と.NET XmlNameSpaceManagerオブジェクトを使用して、指定されたXPath式によって識別されるXMLノードを更新します。

宣言

// C#
public void Update(string xpathExpr, XmlNameSpaceManager nsMgr, string
  value);

パラメータ

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

Update(string, string, OracleXmlType)

このメソッドは、指定されたOracleXmlType値に格納されているXMLデータとネームスペース解決用の文字列パラメータを使用して、XPath式によって識別されるXMLノードを更新します。

宣言

// C#
public void Update(string xpathExpr, string nsMap, OracleXmlType value);

パラメータ

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

Update(string, XmlNameSpaceManager, OracleXmlType)

このメソッドは、指定されたOracleXmlType値に格納されているXMLデータとネームスペース解決用の.NET XmlNameSpaceManagerオブジェクトを使用して、XPath式によって識別されるXMLノードを更新します。

宣言

// C#
public void Update(string xpathExpr, XmlNameSpaceManager nsMgr, OracleXmlType     value);

パラメータ

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentNullException: xpathExprはNULLまたはゼロレングスです。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

デフォルトのネームスペースは、その値が空の文字列の場合は無視されます。

Validate

このメソッドは、OracleXmlTypeオブジェクト内のXMLデータが指定されたXMLスキーマに準拠しているかどうかを検証します。

宣言

// C#
public bool Validate(String schemaUrl);

パラメータ

戻り値

XMLデータがXMLスキーマに準拠している場合はtrueを、そうでない場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

ArgumentNullException: schemaUrl引数は、NULLまたは空の文字列です。