hiXMLreader (OtsuLibrary)

java.lang.Object
- otsu.hiGadget.hiXMLreader

public class hiXMLreader
extends Object

XMLシーケンシャル読み取り解析機.

XMLの解析をシーケンシャルに行う機構です。
MIXED型のXML(<A>xxxkokokyyy</A>のようにテキスト内にタグ構造が混ざったもの）は取り扱いません。

シーケンシャルread()によるXML解析:
read()を呼ぶたびに順次XMLのノード hiXMLnode が取得されます。
XMLのnodeとしてreadされるのは次の４つのいずれかです。

TAG
END
TEXT
EOD

XMLデータはこの４つのnode型として順次取り込まれます。
例えば次のような形です。

   <A>                     TAG:A
       <B>                 TAG:B
           <C>abc</C>      TAG:C  TEXT:abc END:C
       </B>                END:B
       <B>                 TAG:B
           <C>def</C>      TAG:C  TEXT:def END:C
       </B>                END:B
       <D>xyz</D>          TAG:D  TEXT:xyz END:D
   </A>                    END:A
   -- readで読み込まれる順
   TAG:A TAG:B TAG:C TEXT:abc END:C END:B TAG:B TAG:C TEXT:def END:C END:B 
   TAG:D TEXT:xyz END:D END:A

SAXを使う場合でも発生するイベントの順は同じですが、 SAXはイベント駆動ですので、例えばTEXTイベント(charcterイベント）が起る場合、それがどこのものであるのかは全く分からず、アプリケーション側で管理する必要があります。

hiXMLreaderではイベント駆動ではなくアプリケーション側から能動的にreadし、情報を取得します。
このため、Aを読んだら、Aの中の処理、その中でBを読んだらBの処理、 Dを読んだらDの処理という形のプログラムを書くことができます。

最初のnodeをread()
if( TAG:A ){
   // Aの構造を作る
   while( read()!=END ){ ※１※２
      if( TAG:B ){          　 ※３
         // Aの構造にBを入れる
         while( read()!=END ){
            if( TAG:C ){
               // AのBにCを入れる
               while( read()!=END ){
                  if( TEXT ){ 　※４
                     // A-B-CにTEXTを入れる
                     }
                  }
               }
            }
         }
      else if( TAG:D ){
         // Aの構造にDを入れる
         while( read()!=END ){
            if( TEXT ){
               // TEXT処理
               }
            }
         }
      }
   }
※１ 入力終了時はEODが返りますが、EODの後もう一度呼ぶとException
　　 が発生するため、万が一の場合でも無限ループにはなりません
※２ 実コード while( reader.read(node)!=hiXMLnode.END )
※３ 実コード if( node.isTag("B") )
※４ 実コード while( reader.read(node)!=hiXMLnode.TEXT )

標準的手順:
次のような手順を踏みます。

import otsu.hiNote.*;
public class Test {
   public static void main(String[] args_){
      try{
         hiXMLreader reader = new hiXMLreader();// インスタンス生成
         reader.parseFile("data.xml");       // 入力指定
         readXML(reader); //　階層呼び出し
         }
      catch(Exception e){
         e.printStackTrace(hiU.err);
         System.exit(1);
         }
      }
   static void readXML(hiXMLreader reader){
      hiXMLnode   node   = new hiXMLnode();
      while( reader.read(node)!= hiXMLnode.EOD ){
         if( node.type==hiXMLnode.END ) break;
         System.out.println(node);
         if( node.type==hiXMLnode.TAG ) readXML(reader); // 階層呼び出し
         }
      }
   }

内部ioスレッド:
ioは内部スレッドでSAXを用いて行われます。
アプリケーションで時間がかかる場合内部のQUEUEサイズ分先読みされます。
SAX部はアプリケーションより先に終了する可能性があります。
通常は意識する必要はありません。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

hiXMLreader()

コンストラクタ
コンストラクタと説明
`hiXMLreader()`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static String`	`formatXML(String xml_)` XML文字列をインデントバー付きでフォーマットする.
`static String`	`formatXML(String xml_, long option_)` XML文字列をインデント付きでフォーマットする.
`static String`	`formatXML(String xml_, String indent1_, String indent2_)` XML文字列をインデント付きでフォーマットする.
`static String`	`formatXML(String xml_, String indent1_, String indent2_, long option_)` XML文字列をインデント付きでフォーマットする.
`String`	`getSourceName()` ソース名を得る.
`void`	`parse_with_Reader(Reader is_)` 指定Readerから読み込む Readerを使った読み込みは文字コードの不一致が起る可能性がありますので推奨されません
`void`	`parse(InputStream is_)` 指定InputStreamから読み込む.
`void`	`parseFile(String fileName_)` 指定ファイルを読み込む.
`void`	`parseString(String str_)` 指定文字列をＸＭＬとして読み込む.
`void`	`push(hiXMLnode node_)` nodeを書き戻す.
`hiXMLnode`	`read()` hiXMLnodeを読み込む.
`int`	`read(hiXMLnode node_)` 引数の`hiXMLnode`にノード情報を読み込む.
`void`	`reset()` 読み込みをリセットする
`void`	`setQueueSize(int size_)` 内部でのXML読読み込み部(SAX)とAP部のQUEUEのサイズ指定.
`void`	`setSourceName(String name_)` ソース名をセットする.
`int`	`skip()` 現状レベルのENDまでスキップする.
`int`	`skip(hiXMLnode node_)` 現状レベルのENDまでスキップする.

クラスから継承されたメソッド java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
 - hiXMLreader
```
public hiXMLreader()
```
- メソッドの詳細
 - read
```
public hiXMLnode read()
```
 hiXMLnodeを読み込む.
 XMLノードを読み込みhiXMLnodeを返します。
 Documentの終わりに達するか、なんらかの異常があると EODが戻ります。
 EODに一度達すると２度目のread()呼び出しはExceptionを発生します。
 最外郭のタグのENDを待つ構造を採る場合EODを待つ必要はありません。
 
 戻り値:
 
 読み込んだノード
 - read
```
public int read(hiXMLnode node_)
```
 引数のhiXMLnodeにノード情報を読み込む.
 予め用意したノード構造体にデータを読み込みます。
 戻り値はノードのtype情報であり、
```
emsp;while( reader.read(node)!=hiXMLnode.END ){...}
```
 といった形の制御が可能です。
 Documentの終わりに達するか、なんらかの異常があると EODが戻ります。
 EODに一度達すると２度目のread()呼び出しはExceptionを発生します。
 最外郭のタグのENDを待つ構造を採る場合EODを待つ必要はありません。
 パラメータ:
 
 node_ - 読み取りに使うnode構造体
 
 戻り値:
 
 nodeの型
 - push
```
public void push(hiXMLnode node_)
```
 nodeを書き戻す.
 書き戻したnodeは次のreadで読み取られます。
 複数回pushした場合はpushした最新のpushから順に readされます。
 
 パラメータ:
 
 node_ - 書き戻すnode
 - skip
```
public int skip(hiXMLnode node_)
```
 現状レベルのENDまでスキップする.
 現在のレベルのENDまでスキップする。
```
<A>
 
 この段階でskipすると
 <C>
 
 <D>..</D>
 
 </C>
 <E>..</E>
 <--ここまで読み飛ばされ、次に読み込むと</A>が来る
</A>
```
 最後に読み取ったnode(この例ではBのEND)が引数にセットされる
 パラメータ:
 
 node_ - 読み取りに使うnode構造体
 
 戻り値:
 
 最後のコード(END)
 - skip
```
public int skip()
```
 現状レベルのENDまでスキップする.
 現在のレベルのENDまでスキップする。
```
<A>
 
 この段階でskipすると
 <C>
 
 <D>..</D>
 
 </C>
 <E>..</E>
 <-- ここまで読み飛ばされ、次に読み込むと</A>が来る
</A>
```
 戻り値:
 
 最後のコード(END)
 - parseFile
```
public void parseFile(String fileName_)
```
 指定ファイルを読み込む.
 読み込むファイルを指定します。この呼び出しの後、readで情報が順次読み取ることができます。
 
 パラメータ:
 
 fileName_ - ファイル名
 - parse
```
public void parse(InputStream is_)
```
 指定InputStreamから読み込む.
 読み込む入力ストリームを指定します。この呼び出しの後、readで情報が順次読み取ることができます。
 
 パラメータ:
 
 is_ - 入力ストリーム
 - parseString
```
public void parseString(String str_)
```
 指定文字列をＸＭＬとして読み込む.
 解析するテキストを指定します。この呼び出しの後、readで情報が順次読み取ることができます。
 
 パラメータ:
 
 str_ - XMLテキスト
 - parse_with_Reader
```
public void parse_with_Reader(Reader is_)
```
 指定Readerから読み込む
 Readerを使った読み込みは文字コードの不一致が起る可能性がありますので推奨されません
 
 パラメータ:
 
 is_ - 入力リーダー
 - reset
```
public void reset()
```
 読み込みをリセットする
 - setSourceName
```
public void setSourceName(String name_)
```
 ソース名をセットする.
 InputStreamやReaderを指定している時に、仮の名前を与えることができまえす。エラー発生時にはこの名前がでます。
 
 パラメータ:
 
 name_ - 名前
 - getSourceName
```
public String getSourceName()
```
 ソース名を得る.
 設定されているソース名を得ます。ソース名はparseFile()あるいはsetSourceName()で与えたものです。
 
 戻り値:
 
 名前
 - setQueueSize
```
public void setQueueSize(int size_)
```
 内部でのXML読読み込み部(SAX)とAP部のQUEUEのサイズ指定.
 XMLの読み込み部とAP部は別スレッドで動作させています。
 ２つのスレッドではQUEUE(hiSyncQue<T>クラス)を介してデータを移動しています。
 parse関数(parseFile(String)など）の呼び出し前にこの関数でQUEUEサイズを指定できます。
 0は可能な限りQUEUEに入れます。デフォルトは30です。
 
 パラメータ:
 
 size_ - サイズ
 - formatXML
```
public static String formatXML(String xml_)
```
 XML文字列をインデントバー付きでフォーマットする.
 XML文字列をインデントバー付きにフォーマットします。
 改行には改行コード"\n"が用いられます。
 インデントは"| "バー付きで、５段目毎に"! "となります。
 コメント%lt;!-- comment -->がある場合正確な動作は保証しません。
```
 String xml="<a><c>CCC</c><d>DDD</d><e>EEE</e></a>";
 System.out.println(hiXMLreader.formatXML(xml));
 ----
 <a>
 | 
 | | <c>CCC</c>
 | | <d>DDD</d>
 | 
 | <e>EEE</e>
 </a>
```
 バー文字列を指定することも出来ます。" "を指定すれば通常のXMLになります。
```
 println(hiXMLreader.formatXML(xml," "," ");
 ---
 <a>
 
 <c>CCC</c>
 <d>DDD</d>
 
 <e>EEE</e>
 </a>
```
 パラメータ:
 
 xml_ - フォーマットされてないXML
 
 戻り値:
 
 バー付きでフォーマットされたXML
 - formatXML
```
public static String formatXML(String xml_,
 long option_)
```
 XML文字列をインデント付きでフォーマットする.
 formatXML(String xml_)のオプションを指定する版です。
 
 パラメータ:
 
 xml_ - フォーマットされていないXML
 
 option_ - hiU.NO_COMMENTを指定するとコメントを削除する
 
 戻り値:
 
 指定インデント文字列でインデントの付けられたXML
 - formatXML
```
public static String formatXML(String xml_,
 String indent1_,
 String indent2_)
```
 XML文字列をインデント付きでフォーマットする.
 formatXML(String xml_)のバーを指定する版です。
 
 パラメータ:
 
 xml_ - フォーマットされていないXML
 
 indent1_ - 基本的なインデント文字列
 
 indent2_ - ５段目毎のインデント文字列
 
 戻り値:
 
 指定インデント文字列でインデントの付けられたXML
 - formatXML
```
public static String formatXML(String xml_,
 String indent1_,
 String indent2_,
 long option_)
```
 XML文字列をインデント付きでフォーマットする.
 formatXML(String xml_)のバーとオプションを指定する版です。
 
 パラメータ:
 
 xml_ - フォーマットされていないXML
 
 indent1_ - 基本的なインデント文字列
 
 indent2_ - ５段目毎のインデント文字列
 
 option_ - hiU.NO_COMMENTを指定するとコメントを削除する
 
 戻り値:
 
 指定インデント文字列でインデントの付けられたXML

クラス hiXMLreader

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

hiXMLreader

メソッドの詳細

read

read

push

skip

skip

parseFile

parse

parseString

parse_with_Reader

reset

setSourceName

getSourceName

setQueueSize

formatXML

formatXML

formatXML

formatXML