otsu.hiGadget

クラス hiXMLnode

java.lang.Object

otsu.hiGadget.hiXMLnode

public class hiXMLnode
extends Object

hiXMLreader.read()で得られるXMLのノード情報.

publicなメンバ

type		ノードの種別 (TAG, TEXT, END, EOD)
attributes		属性情報辞書
text		内容(タグ名、テキスト内容）

と幾つかの補助情報から構成される単純な構造体です。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
HashMap<String,String>	attributes typeがTAGの場合属性値がセットされる.
static int	END nodeタイプがEND(終了タグ)であることを示す.
static int	END_OF_NULL タイプENDが空の終わりでることを示すサブタイプ.
static int	END_OF_STRUCT タイプENDが構造の終わりであることを示すサブタイプ.
static int	END_OF_TEXT タイプENDがTEXTの終わりであることを示すサブタイプ.
static int	EOD nodeタイプがEODまたは無情報であることを示す.
Exception	exception 解析例外があった場合は type==EOD で詳細はここに入る.
int	line ノードを取得した行番号.
int	nest 階層.
static int	NO_INFO サブタイプ情報が無いことを示す.
String	source_name XMLソース名.
int	sub_type nodeの補助種別.
static int	TAG nodeタイプがタグであることを示す.
String	text TAG、TEXTの場合内容がセットされる.
static int	TEXT nodeタイプがテキストであることを示す.
int	type nodeの種別.

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

コンストラクタ

コンストラクタと説明
hiXMLnode() 空のnodeを作る

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getAttribute(String attrName_) 属性を取得する.
boolean	isTag(String tag_) タイプがTAGでかつtextが指定文字列であるかチェックする.
static String	nameInXML(String str_) XMLの名前形式に文字列変換する.
static String	stringInXML(String str_) XMLデータ文字列形式に変換する.
String	toString() Java標準のtoStringメソッド.
String	toXMLString() XMLのノード形式の文字列を得る.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

EOD

public static final int EOD

nodeタイプがEODまたは無情報であることを示す.

　 *XMLが最後に達したかエラーになった場合typeにEODがセットされます。
最外郭のタグのENDを確認する場合、EODの判断は不要です。
type==EODの場合、text,attributesは無効です。

関連項目:

定数フィールド値

TAG

public static final int TAG

nodeタイプがタグであることを示す.

関連項目:

定数フィールド値

TEXT

public static final int TEXT

nodeタイプがテキストであることを示す.

関連項目:

定数フィールド値

END

public static final int END

nodeタイプがEND(終了タグ)であることを示す.

関連項目:

定数フィールド値

NO_INFO

public static final int NO_INFO

サブタイプ情報が無いことを示す.

関連項目:

定数フィールド値

END_OF_STRUCT

public static final int END_OF_STRUCT

タイプENDが構造の終わりであることを示すサブタイプ.

関連項目:

定数フィールド値

END_OF_TEXT

public static final int END_OF_TEXT

タイプENDがTEXTの終わりであることを示すサブタイプ.

関連項目:

定数フィールド値

END_OF_NULL

public static final int END_OF_NULL

タイプENDが空の終わりでることを示すサブタイプ.

関連項目:

定数フィールド値

type

public int type

nodeの種別.

読み込んだノード種別がセットされます。
TAG,END,TEXT,EODの何れかの値となります。

   <A>            TAG:A
      <B>aaa</B>  TAG:B TEXT:aaa END:B
      <C></C>     TAG:C END:C
   </A>           END:A

sub_type

public int sub_type

nodeの補助種別.

NO_INFO,END_OF_STRUCT,END_OF_TEXT,END_OF_NULLの何れかの値となります。

   <A>            TAG:A(NO_INFO)
      <B>aaa</B>  TAG:B(NO_INFO) TEXT:aaa(NO_INFO) END:B(END_OF_TEXT)
      <C></C>     TAG:B(NO_INFO) END:C(END_OF_NULL)
   </A>           END:A(END_OF_STRUCT)

text

public String text

TAG、TEXTの場合内容がセットされる.

TEXTの場合値は通常の文字となっています。"&lt;"などは"<"となっています。

attributes

public HashMap<String,String> attributes

typeがTAGの場合属性値がセットされる.

属性名Stringをキーとし、値Stringを内容とする辞書です。
type==TAG以外の場合はnullです。
TAGの場合属性値がない場合空のHashMapとなりnullになることはありません。

特定の属性を得る例)
  if( node.type==hiXMLnode.TAG ){
     String a_value= node.attributes.get("at0");
     if( a_value!=null ){
         System.out.printf("TAG %s has attribute %s %s%n"
                           ,node.text,"at0",a_value);
         }
      }
全アトリビュートを調べる例)
  if( node.type==hiXMLnode.TAG ){
     for(String key:node.attributes.keySet()){
        System.out.println("name="+key+" value="+node.attributes.get(key));
        }
     }

nest

public int nest

階層.

ノードの階層を示します。

source_name

public String source_name

XMLソース名.

hiXMLreader.parseFile(String)で読み込み指定したファイルまたは hiXMLreader.setSourceName(String)で指定した文字列が入ります。
指定がない場合はnullとなります。

line

public int line

ノードを取得した行番号. ノードを取得したおおよその行番号を表します。目安程度と考えてください。

exception

public Exception exception

解析例外があった場合は type==EOD で詳細はここに入る.

nullの場合もあります。
XMLのフォーマットに異常がある場合、通常SAXParseException がセットされます。

コンストラクタの詳細

hiXMLnode

public hiXMLnode()

空のnodeを作る

メソッドの詳細

isTag

public boolean isTag(String tag_)

タイプがTAGでかつtextが指定文字列であるかチェックする.

パラメータ:

tag_ - タグ文字列

戻り値:

真：指定タグである、偽：指定タグではない。

toString

public String toString()

Java標準のtoStringメソッド.

標準のtoStringメソッドを持つので、

 // hiXMLnode node;
 System.out.println("NODE="+node);

のような形で内容を表示することができます。
値の中の&quot;などの特殊文字は全て通常の文字に変換された 状態になっています。

次のコード
  while( reader.read(node)!=hiXMLnode.EOD ){
     System.out.println("node="+node);
     }
で次のデータ
  <?xml version="1.0" encoding="UTF-8"?>
  <A at1="ab&ap;apos;c" at2='xy"z'>
     <B><C><D>XXXX</D></C><D>kk</D></B><N></N>
  <A>
を読み表示させると次の結果が得られます
  node=[TAG:A]
  node=[TAG:B]
  node=[TAG:C]
  node=[TAG:D]
  node=[TEXT:XXXX]
  node=[END:D]
  ・・・省略・・・
  node=[END:A]

オーバーライド:

toString クラス内 Object

戻り値:

文字列表記

toXMLString

public String toXMLString()

XMLのノード形式の文字列を得る.

XML記述の形の文字列が得られます。
・TAGの場合 <名前 属性名="属性値" ..>
・ENDの場合 </名前>
・TEXTの場合 内容文字列
・EODの場合 <!-- EOD -->
属性値の並び順は保障されません。
属性値の中のダブルクオートは&amp;になります。
属性値の中のシングルクオートは&apos;になります。
属性値および内容文字列の中の<は&lt;になります。

次のコード
  while( reader.read(_node)!=hiXMLnode.EOD ){
     if( node.type==hiXMLnode.TAG ){
        System.out.print("\n"+hiU.indent(node.nest));
        }
     else if( node.sub_type==hiXMLnode.END_OF_STRUCT){
        System.out.print("\n"+hiU.indent(node.nest));
        }
     System.out.print(node.toXMLString());
     }
  System.out.println("");
で次のデータ
  <?xml version="1.0" encoding="UTF-8"?>
  <A at1="ab&ap;apos;c" at2='xy"z'>
     <B><C><D>XXXX</D></C><D>kk</D></B><N></N>
  <A>
を読み表示させると次の結果が得られます。
  <A at2="xy&quot;z" at1="ab&apos;c">
     <B>
        <C>
           <D>XXXX</D>
        </C>
        <D>kk</D>
     </B>
     <N></N>
  </A>
なお、ネスト表す空白はhiU.indent()が出しています。

戻り値:

XML文字列表記

nameInXML

public static String nameInXML(String str_)

XMLの名前形式に文字列変換する.

a-zA-Z0-9_および-以外を_に変換します

パラメータ:

str_ - 文字列

戻り値:

XMLの名前形式の文字列

stringInXML

public static String stringInXML(String str_)

XMLデータ文字列形式に変換する.

<を&lt;に&を&amp;に"を&quot;に 'を&apos;に 変換します。

パラメータ:

str_ - 文字列

戻り値:

XML内文字列

getAttribute

public String getAttribute(String attrName_)

属性を取得する.

指定属性を持たない場合、nullまたは長さ0の文字列が返ります。

パラメータ:

attrName_ - 属性名

戻り値:

属性値