XML（DOMガイド）

Size: px

Start display at page:

Download "XML（DOMガイド）"

なおみすえがら
5 years ago
Views:

1 XML DOM ガイド初心者の為の XML DOM ガイドイントロダクション本稿は XML(eXtensible Markup Language) 形式のドキュメントからデータを受け取ろうと仕て居る Microsoft Visual Basic の開発者を対象と仕て居る此処では XML ドキュメントから情報を取得し其のデータを Visual Basic のソリューションに統合する方法を説明する亦本稿の読者は自分自身でコードを作成出来て最終的にはテキストファイルと成る XML ファイルの内容を自分自身で解析出来る事を前提として居る此れは非生産的な方法で XML の良い特長を損なう物で有る本来 XML はデータを表す為の構造化された方法なので自分で目視して解析等をする必要は無い XML ファイルから情報を取得するには XML パーサーを使用する事を勧める XML パーサーは XML を読み込んで其の中のデータを利用可能にする非常にシンプルなソフトウェアで有る Visual Basic の開発者は XML DOM(Document Object Model) をサポートするパーサーを使用する事が出来る DOM はパーサーが公開する標準的なコマンドセットを定義して居る此れに依りプログラムから HTML や XML ドキュメントの内容にアクセスする事が出来る DOM をサポートする XML パーサーはデータを XML ドキュメントから取り込みプログラム可能な一連のオブジェクトを通じてデータに操作する事が出来る様にする本稿では Microsoft XML パーサー (Msxml.dll) に依る XML DOM の実装を介した XML ドキュメントへのアクセスと操作方法に付いて説明する先に進む前に処理前の XML ファイルを直接開いてパーサーが如何に効果的に機能するかに付いての理解を深める為の説明を行う下記のコードは CD の項目を含む Cds.xml ファイルの内容を公開する各項目にはアーティストタイトルトラック等の情報が含まれて居る <?xml version="1.0"?> <!DOCTYPE compactdiscs SYSTEM "cds.dtd"> <compactdiscs> <compactdisc> <artist type="individual">frank Sinatra</artist> <title numberoftracks="4">in The Wee Small Hours</title> <tracks> <track>in The Wee Small Hours</track> <track>mood Indigo</track> <track>glad To Be Unhappy</track> <track>i Get Along Without You Very Well</track> </tracks> <price>$12.99</price> </compactdisc> <compactdisc> <artist type="band">the Offspring</artist> <title numberoftracks="5">americana</title> <tracks> <track>welcome</track> <track>have You Ever</track> -1-

2 <track>staring At The Sun</track> <track>pretty Fly (For A White Guy)</track> </tracks> <price>$12.99</price> </compactdisc> </compactdiscs> 上記のドキュメントの 2 行目で外部の DTD(Document Type Definition) ファイルを参照して居る DTD はレイアウトや特定の種類の XML ドキュメントに対して予期される内容を定義して居る XML パーサーは DTD を使用してドキュメントが DTD に従って居るか何うかを判断する事が出来る DTD はパーサーがドキュメントの有効性を判断する為に使用する方法の 1 つで有るドキュメントの有効性を判断する為に一般化しつゝ有るもう一つの方法は XML スキーマで有る独自の特徴有る構文を使用する DTD に対して XML スキーマでは XML を使用してスキーマを定義する下記のコードは Cds.xml に依り使用される Cds.dtd の内容を表示する <!ELEMENT compactdiscs (compactdisc*)> <!ELEMENT compactdisc (artist, title, tracks, price)> <!ENTITY % Type "individual band"> <!ELEMENT artist (#PCDATA)> <!ATTLIST artist type (%Type;) #REQUIRED> <!ELEMENT title (#PCDATA)> <!ATTLIST title numberoftracks CDATA #REQUIRED> <!ELEMENT tracks (track*)> <!ELEMENT price (#PCDATA)> <!ELEMENT track (#PCDATA)> 此処では DTD や XML スキーマの内容に付いては詳しく説明しない XML Schema language( 英語 ) は W3C に提出された XML-Data( 英語 ) ノートに基づいて居る DOM に付いて XML の DOM は XML ドキュメントの内容を公開するオブジェクトモデルで有る W3C の Document Object Model (DOM) Level 1 Specification では現在 DOM が表示するプロパティメソッド及びイベントの種類を定義して居る Microsoft の DOM 実装は W3C 標準を完全にサポートして居り更に追加された機能も有る此の機能を使うと作成するプログラムに於ける XML ファイルの操作をより簡単に行う事が出来る XML DOM の使用方法 XML DOM を使用するには XML パーサーのインスタンスを作成する此れを可能にする為に Microsoft は Msxml.dll の中の一連の COM インターフェイスを使用して XML DOM を公開して居る Msxml.dll には XML ドキュメントで使用可能なタイプライブラリと実装コードが含まれて居る Internet Explorer で実行する VBScript 等のスクリプトクライアントを使用して居る場合は CreateObject メソッドに依り DOM を使用し Parser オブジェクトのインスタンスを作成する -2-

Set objparser = CreateObject( "Microsoft.XMLDOM" ) Active Server Page(ASP) の VBScript を使用して居る場合は Server.CreateObject を使用する Set objparser = Server.CreateObject( "Microsoft.XMLDOM" ) Visual Basic を使用して居る場合は Msxml.

3 Set objparser = CreateObject( "Microsoft.XMLDOM" ) Active Server Page(ASP) の VBScript を使用して居る場合は Server.CreateObject を使用する Set objparser = Server.CreateObject( "Microsoft.XMLDOM" ) Visual Basic を使用して居る場合は Msxml.dll で提供される MSXML タイプライブラリへの参照を設定する事に依り DOM にアクセス出来る Visual Basic 6.0 で MSXML を使用するには下記の操作を行う 1.[ プロジェクト ] メニューから [ 参照設定 ] ダイアログボックスを開く 2. 表示される COM オブジェクトの一覧の Microsoft XML, version 2.0 をクリックする此の項目が表示されない場合は MSXML ライブラリが必要で有る 3. 此れで Parser オブジェクトのインスタンスを作成する事が出来る Msxml.dll を取得するには下記の孰れかの方法で MSXML ライブラリを入手する Internet Explorer 5.0 をインストールするコンポーネントに MSXML パーサーが含まれて居る Microsoft XML Parser( 英語 ) の再配布可能バージョンをダウンロードする Visual Basic プロジェクトでタイプライブラリを参照するとパーサーを使用してドキュメントを読み込み其のデータを使用する事が出来る様に成る何の作業して居るのかと疑問に感じた時には Visual Basic 6.0 のオブジェクトブラウザで MSXML ライブラリを開きオブジェクトモデルを調べるとオブジェクトモデルが非常に豊富で有る事が解る本稿では DOMDocument クラスと IXMLDOMNode インターフェイスを使用して XML ドキュメントにアクセスする方法を説明するドキュメントの読み込み方法 XML ドキュメントを読み込むには先ず最初に DOMDocument クラスのインスタンスを作成する必 -3-

4 要が有る有効な参照値を取得した後 Load メソッドを使用してファイルを開く MSXML パーサーを使用すると UNC 参照を使用したネットワーク又は URL を介してローカルディスクから XML ドキュメントを読み込む事が出来るディスクからドキュメントを読み込むには Load メソッドを使用して下記の構文を作成する If xdoc.load("c: My Documents cds.xml") Then ドキュメントでの作業が終了すれば必ずオブジェクト参照を解放する必要が有る MSXML パーサーでは明示的な Close メソッドは公開されて居ない此の為参照先を Nothing に設定するパーサーにファイルの読込を要求すると既定では非同期的に読み込みが行われるドキュメントの Boolean Async プロパティを変更すると既定の設定を変更出来るドキュメントの内容を操作する前にドキュメントの ReadyState プロパティを調べドキュメントの準備が整って居る事を確認する ReadyState プロパティは下記の 5 つの値の孰れかを返す状態値 Uninitialized: 読込は開始して居ない 0 Loading:Load メソッドを実行中で有る 1 Loaded:Load メソッドが完了した 2 Interactive:DOM が読み取り専用で操作可能で有るデータの一部丈が解析済みで有る 3 Completed: データの読込と解析が完了し読み取りと書き込み作業が可能で有る 4 MSXML パーサーは読込処理のステータスを追跡する為に大きなドキュメントの読み込み時に使用可能なイベントを公開する此等のイベントはインターネットを介して URL から非同期的にドキュメントを読み込む場合にも役立つ URL を使用してファイルを開くには完全な URL アドレスでファイルの場所を指定するファイルの場所を示すアドレスの前にを付ける必要が有る URL を使用してファイルを読み込む例を下記に示す xdoc.async = False If xdoc.load(" Then -4-

5 ドキュメントの Async プロパティを False に設定するとドキュメントが完全に読み込まれて処理の準備が整う迄パーサーはコードにコントロールを返さない True に設定した場合ドキュメントにアクセスする前に ReadyState プロパティを調べるか DOMDocument のイベントを使用してドキュメントの準備が完了した際に通知を行うコードを設定する必要が有るエラーの対処様々な理由に依りドキュメントを読み込めない場合が有る一般的な理由と仕ては Load メソッドに渡されるドキュメント名が無効で有る事等が考えられる其の他の理由と仕ては XML ドキュメント自体が無効で有る場合等も考えられる既定ではドキュメントに DTD 又はスキーマが特定されて居る場合 MSXML パーサーはドキュメントを孰れかに照らし合わせて確認する Load メソッドを実行する前に DOMDocument 参照オブジェクトの ValidateOnParse プロパティを設定してパーサーがドキュメントを確認しない様にも設定する事が出来る xdoc.validateonparse = False If xdoc.load("c: My Documents cds.xml") Then 開発する製品版のアプリケーションでパーサーの確認機能をオフにする事は推奨出来ないドキュメントが正しくない為に様々な理由でプログラムにエラーが発生する可能性が有るエラーが発生しない場合でも無効なデータが読み込まれる可能性が有る ParseError オブジェクトにアクセスすると種類に拘らずエラーに関する情報をパーサーに要求する事が出来る ParseError オブジェクトのプロパティを使用するにはドキュメント自体の IXMLDOMParseError インターフェイスへの参照を設定する IXMLDOMParseError インターフェイスはエラーの原因を調査する際に使用可能な 7 つのプロパティを公開する下記の例ではメッセージボックスと ParseError オブジェクトから取得可能なエラー情報を表示する If xdoc.load("c: My Documents cds.xml") Then -5-

6 Dim strerrtext As String Dim xpe As MSXML.IXMLDOMParseError ' ParseError オブジェクトを取得する Set xpe = xdoc.parseerror With xpe strerrtext = " 下記の XML ドキュメントの読込に失敗 :" & _ " 下記のエラーが原因で有る " & vbcrlf & _ " エラー # : " &.errorcode & ": " & xpe.reason & _ " 行 #: " &.Line & vbcrlf & _ " 行位置 : " &.linepos & vbcrlf & _ " ファイル内の位置 : " &.filepos & vbcrlf & _ " ソーステキスト : " &.srctext & vbcrlf & _ " ドキュメント URL : " &.url End With MsgBox strerrtext, vbexclamation Set xpe = Nothing ParseError オブジェクトに依り公開される情報を使用して此の情報を表示しエラーファイルに記録したりエラーを修正する事が出来る XML ドキュメントからの情報の取得ドキュメントの読込が完了したら此のドキュメントから情報を取得するドキュメントオブジェクトは重要だが殆どの場合 IXMLDOMNode インターフェイスを使用する IXMLDOMNode インターフェイスを使用して各ノードの要素に対して読み取り / 書き込みを行う MSXML パーサーでは現在 13 種類のノードをサポートして居る下記の表に一覧表示されて居るのは最も一般的なノードタイプの一部で有る DOM ノードタイプ NODE_ELEMENT NODE_ATTRIBUTE NODE_TEXT NODE_PROCESSING_INSTRUCTION NODE_DOCUMENT_TYPE 例 <artist type="band">the Offspring</artist> <artist type="band">the Offspring</artist> <artist type="band">the Offspring</artist> <?xml version="1.0"?> <!DOCTYPE compactdiscs SYSTEM "cds.dtd"> IXMLDOMNode インターフェイスに依り公開される 2 つのプロパティを通じてノードタイプにアクセスする NodeType プロパティは DOMNodeType アイテムの列挙を公開する此の内の幾つかは上の一覧に表示されて居る更に NodeTypeString を使用してノードタイプの文字列を取得出来るドキュメントへの参照を取得するとノード階層の走査を開始出来るドキュメントへの参照から ChildNodes プロパティにアクセス出来る ChildNodes プロパティはドキュメントの総てのノードへのトップダウン形式のエントリポイントを提供する ChildNodes プロパティは Visual Basic の For/Each 構造をサポートする IXMLDOMNodeList を公開する此の為 ChildNodes プロパティの各ノードを総て列挙する事が出来る更に ChildNodes プロパティは存在する子ノードの数を返す Level プロパ -6-

7 ティを公開するドキュメントオブジェクト丈でなく各ノードも同様に ChildNodes プロパティを公開する此れに依り IXMLDOMNode の HasChildNodes プロパティと共に要素属性値を調査して簡単にノードの階層を走査する事が出来る注意す可き点はドキュメントの要素と其の要素の値との親子関係で有る例えば CD XML ドキュメントでは要素 <title> は曲のタイトルを公開する <title> 要素の実際の値を取得するには NODE_TEXT タイプのノードを調べる必要が有る目的のデータを持つノードを見つければ ParentNode プロパティを通じて属性を調査し親ノードを確認した上でアクセス出来るドキュメントの走査方法 XML ドキュメント内でドキュメントオブジェクトに依り公開された一連のノードを走査する XML ドキュメントは階層形式で有る為ドキュメント全体を走査する再帰ルーチンを比較的簡単に作成する事が出来る LoadDocument ルーチンは XML ドキュメントを開いた後もう一つのルーチン DisplayNode を呼び出す此のルーチンが実際にドキュメントを走査する LoadDocument はパラメータやインデントレベルの開始位置を指定する整数値と仕て現在開いて居る XML ドキュメントの ChildNodes プロパティに参照を渡す Indent パラメータはコード中でドキュメントの構造体を Visual Basic のイミディエイトウィンドウに表示する際の書式を指定する DisplayNode 関数は特に NODE_TEXT タイプのノードをドキュメントから探す関数が NODE_TEXT タイプのノードを見付けると NodeValue プロパティを使用してノードのテキストを取得する更に現在のノードの ParentNode プロパティを使用して NODE_ELEMENT タイプの参照元を取得する NODE_ELEMENT タイプのノードは NodeName プロパティを公開する NodeName と NodeValue の内容が表示される HasChildNodes プロパティを調べる事に依りノードに子ノードが存在して居る事が判明するとドキュメントの最後に達する迄 DisplayNode が再帰的に自身を呼び出す DisplayNode ルーチンは Debug.Print を使用して Visual Basic のイミディエイトウィンドウに情報を書き込む Public Sub LoadDocument() xdoc.validateonparse = False If xdoc.load("c: My Documents sample.xml") Then DisplayNode xdoc.childnodes, 0 ' エラー情報に付いては上記の一覧を参照する End Sub -7-

8 Public Sub DisplayNode(ByRef Nodes As MSXML.IXMLDOMNodeList, ByVal Indent As Integer) Dim xnode As MSXML.IXMLDOMNode Indent = Indent + 2 For Each xnode In Nodes If xnode.nodetype = NODE_TEXT Then Debug.Print Space$(Indent) & xnode.parentnode.nodename & ":" & xnode.nodevalue If xnode.haschildnodes Then DisplayNode xnode.childnodes, Indent Next xnode End Sub -8-

ＶＢ．ＮＥＴ解説

ＶＢ．ＮＥＴ解説 Visual Basic.NET 印刷編目次印刷の概要... 2 印刷の流れ... 2 標準の Windows フォーム印刷ジョブの作成... 3 実行時に於ける Windows フォーム印刷オプションの変更... 3 Windows フォームに於ける接続されたプリンタの選択... 4 Windows フォームでのグラフィックスの印刷... 5 Windows フォームでのテキストの印刷...