otsu.hiGadget

クラス hiDom

java.lang.Object

otsu.hiGadget.hiDom

public class hiDom
extends Object

Dom(Document/Element)の取り扱いを補助するstatic関数群.

DOM(Document/Element)の取り扱いを簡便化します。
Nodeは隠蔽しています。
ElementのリストはArrayList<Element>としています。

DOM関連で必要なimportは次のものです。

// DOM関連
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.*;

Dom(Document/Element)のインターフェースも用い次のようなアクセスができます。

import otsu.hiNote.*;
import java.util.*;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
public class Test {
   public static void main(String[] args_){
      try{
         Document doc = hiDom.readXMLfile("data.xml"); 
         chkElm(doc.getDocumentElement());
         }
      catch(Exception e){
         e.printStackTrace(hiU.err);
         System.exit(1);
         }
      }
   static void chkElm(Element element){
      ArrayList<Element> elms=hiDom.getChildElements(element);
      for(Element elm:elms){
         if(hiDom.isTextElement(elm)){
            System.out.println(elm.getTagName()+":"
                               +hiDom.getText(elm));
            }
         else{
            System.out.println(elm.getTagName());
            chkElm(elm);
            }
         }
      }
   }

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static boolean	indent

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static Element	appendElement(Document doc, Element elm, String name) Elementに指定タグ名のElementを追加する.
static Element	appendElement(Document doc, String name) Documentに指定タグ名のElementを追加する.
static Element	appendElement(Element to_, Element elm_) 他Documentからのelementを取り込む。
static Element	appendElement(Element elm, String name) Elementに指定タグ名のElementを追加する.
static Element	appendTextElement(Document doc, Element elm, String name, String text) Elementに指定タグ名のテキストElementを追加する.
static Element	appendTextElement(Element elm, String name, String text) Elementに指定タグ名のテキストElementを追加する.
static HashMap<String,String>	getAttributes(Element elm_) Elementの全attributeを取得する。
static ArrayList<Element>	getChildElements(Element elm) 子Elementのリストを取得する.
static Element	getChildTaggedElement(Element elm, String tag) 指定TagのElement1個を取得する.
static ArrayList<Element>	getChildTaggedElements(Element elm, String tag) 指定TagのElementリストを取得する.
static Element	getFirstChildElement(Element elm)
static Element	getTaggedElement(Element elm, String tag) 指定TagのElementを取得する.
static ArrayList<Element>	getTaggedElements(Element elm, String tag) 指定TagのElementリストを取得する.
static String	getText(Element elm) テキスト部を得る.
static boolean	isTextElement(Element elm) 子要素がテキストか調べる.
static Document	newDocument() 新規DOM(Document)を作成する.
static void	print(Node node_, OutputStream wrt_) DocumentまたはElementを印字する.
static void	print(Node node_, OutputStream outs_, String charSet_) DocumentまたはElementを印字する.
static void	print(Node node_, Writer wrt_) DocumentまたはElementを印字する.
static void	print(Node node_, Writer wrt_, String charSet_) DocumentまたはElementを印字する.
static String	printDom(Document doc_)
static void	printDom(Document doc_, OutputStream wrt_)
static void	printDom(Document doc_, OutputStream outs_, String charSet_)
static String	printDom(Document doc_, String charSet_)
static void	printDom(Document doc_, Writer wrt_)
static void	printDom(Document doc_, Writer wrt_, String charSet_)
static Document	readXMLfile(File file_) 指定名のXMLファイルを読みDOM(Document)を得る
static Document	readXMLfile(String fileName_) 指定名のXMLファイルを読みDOM(Document)を得る 次の作業に相当します。
static Document	readXMLsource(InputSource is_) 指定名の入力ソースを読みDOM(Document)を得る.
static Document	readXMLstream(InputStream is_) 指定名の入力ストリームを読みDOM(Document)を得る.
static Document	readXMLtext(String text_) XML-Text読みDOM(Document)を得る.
static void	setAttributes(Element elm_, HashMap<String,String> attrs_) Elementに複数のattributeを設定する
static String	toString(Node node_) DocumentまたはElementを文字列にする.
static String	toString(Node node_, String charSet_) 文字列にする.

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

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

フィールドの詳細

indent

public static boolean indent

メソッドの詳細

readXMLfile

public static Document readXMLfile(String fileName_)

指定名のXMLファイルを読みDOM(Document)を得る

次の作業に相当します。

---
DocumentBuilderFactory dfact  =DocumentBuilderFactory.newInstance();
DocumentBuilder        builder=dfact.newDocumentBuilder();
Document               doc    =builder.parse(new File(fileName_));

パラメータ:

fileName_ - XMLファイル名

戻り値:

生成されたDOM(Document)

readXMLfile

public static Document readXMLfile(File file_)

指定名のXMLファイルを読みDOM(Document)を得る

パラメータ:

file_ - XMLファイル

戻り値:

生成されたDOM(Document)

readXMLstream

public static Document readXMLstream(InputStream is_)

指定名の入力ストリームを読みDOM(Document)を得る.

パラメータ:

is_ - 入力ストリーム

戻り値:

生成されたDOM(Document)

readXMLsource

public static Document readXMLsource(InputSource is_)

指定名の入力ソースを読みDOM(Document)を得る.

InputSourceを使えばStringに入れたXMLの解析などもできます。

   //import org.xml.sax.InputSource;
   String       text;// ここにXMLデータがあるとする
   StringReader rd = new StringReader(text);
   InputSource  is = new InputSource(rd);
   Document     doc= hiDom.readXMLsource(is);

パラメータ:

is_ - 入力ストリーム

戻り値:

生成されたDOM(Document)

readXMLtext

public static Document readXMLtext(String text_)

XML-Text読みDOM(Document)を得る.

パラメータ:

text_ - 読み込む長文String

戻り値:

読み込んだ結果

newDocument

public static Document newDocument()

新規DOM(Document)を作成する.

次の作業に相当します。

DocumentBuilderFactory _dfact  =DocumentBuilderFactory.newInstance();
DocumentBuilder        _builder=_dfact.newDocumentBuilder();
Document               doc     =_builder.newDocument();

root-elementはhiDom.appendElement()を用いて次のように生成します。

Document doc = hiDom.newDocument();
Element  root= hiDom.appendElement(doc,"root");

戻り値:

新規Document

printDom

public static void printDom(Document doc_,
                            OutputStream outs_,
                            String charSet_)

printDom

public static void printDom(Document doc_,
                            OutputStream wrt_)

printDom

public static void printDom(Document doc_,
                            Writer wrt_,
                            String charSet_)

printDom

public static void printDom(Document doc_,
                            Writer wrt_)

printDom

public static String printDom(Document doc_,
                              String charSet_)

printDom

public static String printDom(Document doc_)

toString

public static String toString(Node node_,
                              String charSet_)

文字列にする.

パラメータ:

node_ - DocumentまたはElement

charSet_ - 文字セット

戻り値:

XML文字列

toString

public static String toString(Node node_)

DocumentまたはElementを文字列にする.

パラメータ:

node_ - DocumentまたはElement

戻り値:

XML文字列

print

public static void print(Node node_,
                         Writer wrt_,
                         String charSet_)

DocumentまたはElementを印字する.

パラメータ:

node_ - DocumentまたはElement

wrt_ - 出力するWriter

charSet_ - 文字セット;nullを指定するとシステム標準

print

public static void print(Node node_,
                         Writer wrt_)

DocumentまたはElementを印字する.

パラメータ:

node_ - DocumentまたはElement

wrt_ - 出力するWriter

print

public static void print(Node node_,
                         OutputStream outs_,
                         String charSet_)

DocumentまたはElementを印字する.

パラメータ:

node_ - DocumentまたはElement

outs_ - 出力するストリーム

charSet_ - 文字セット(utf-8,shift-jisなど);nullを指定するとシステム標準

print

public static void print(Node node_,
                         OutputStream wrt_)

DocumentまたはElementを印字する.

パラメータ:

node_ - DocumentまたはElement

wrt_ - 出力するWriter

getFirstChildElement

public static Element getFirstChildElement(Element elm)

getChildTaggedElements

public static ArrayList<Element> getChildTaggedElements(Element elm,
                                                        String tag)

指定TagのElementリストを取得する.

指定要素の直接の子Elementの中で指定タグのものを得ます。

パラメータ:

elm - 基準Element

tag - タグ

戻り値:

子Elementのリスト

getChildTaggedElement

public static Element getChildTaggedElement(Element elm,
                                            String tag)

指定TagのElement1個を取得する.

指定要素の直接の子Elementの中で指定タグのもの内最初に見つけた1個を得ます。

パラメータ:

elm - 基準Element

tag - タグ

戻り値:

Element　無い場合はnull

getTaggedElements

public static ArrayList<Element> getTaggedElements(Element elm,
                                                   String tag)

指定TagのElementリストを取得する.

指定Elementの子孫Elementで、指定名のタグを持つものを検索します。
Documentから検索するにはDocument.getDocumentElement()で主Element を取得して引数とします。

  // Document doc;
  ArrayList<Element> _elms= hiDom.getChildTaggedElements(
                                  doc.getDocumentElement()
                                 ,"タグ");

パラメータ:

elm - 基準Element

tag - タグ

戻り値:

子Elementのリスト

getTaggedElement

public static Element getTaggedElement(Element elm,
                                       String tag)

指定TagのElementを取得する.

指定Elementの子孫Elementで、指定名のタグを持つものを検索します。
Documentから検索するにはDocument.getDocumentElement()で主Element を取得して引数とします。

  // Document doc;
  ArrayList<Element> _elms= hiDom.getChildTaggedElements(
                                  doc.getDocumentElement()
                                 ,"タグ");

パラメータ:

elm - 基準Element

tag - タグ

戻り値:

子Element　無い場合はnull

getText

public static String getText(Element elm)

テキスト部を得る.

子nodeがTEXT,CDATA-SECTIONの場合、 文字列部を取得します。
それ以外の場合は空の文字列が戻ります。

パラメータ:

elm - テキスト部を得るElement

戻り値:

テキスト

isTextElement

public static boolean isTextElement(Element elm)

子要素がテキストか調べる.

子nodeがTEXT,CDATA-SECTIONか調べます。

パラメータ:

elm - テキスト部を得るElement

戻り値:

テキスト

getChildElements

public static ArrayList<Element> getChildElements(Element elm)

子Elementのリストを取得する.

パラメータ:

elm - 基準Element

戻り値:

子Elementのリスト

appendElement

public static Element appendElement(Document doc,
                                    String name)

Documentに指定タグ名のElementを追加する.

次の作業に相当します。

---
  Element elm= doc.createElement(name);
  doc.appendChild(elm);
  //return  elm;

パラメータ:

doc - このDocumentに追加される

name - 追加するElementの名前

戻り値:

追加されたElement

appendElement

public static Element appendElement(Element elm,
                                    String name)

Elementに指定タグ名のElementを追加する.

次の作業に相当します。

---
  Document doc= elm.getOwnerDocument();
  if( doc==null ){
     throw new Exception("can't get owner-document");
     }
  Element ee= doc.createElement(name);
  elm.appendChild(ee);
  //return  ee;

パラメータ:

elm - このElementに追加される

name - 追加するElementの名前

戻り値:

追加されたElement

appendTextElement

public static Element appendTextElement(Element elm,
                                        String name,
                                        String text)

Elementに指定タグ名のテキストElementを追加する.

テキストElementを追加します。テキストにはHTMLエスケープ が施されます。
次の作業に相当します。

---
  Document doc= elm.getOwnerDocument();
  if( doc==null ){
     throw new Exception("can't get owner-document");
     }
  Element ee= doc.createElement(name);
  ee.appendChild(doc.createTextNode(text));
  elm.appendChild(ee);
  //return ee;

パラメータ:

elm - このElementに追加される

name - 追加するテキストElementの名前

text - 追加するテキスト

戻り値:

追加されたテキストElement

appendElement

public static Element appendElement(Document doc,
                                    Element elm,
                                    String name)

Elementに指定タグ名のElementを追加する.

次の作業に相当します。

---
  Element ee= doc.createElement(name);
  elm.appendChild(ee);
  //return  ee;

パラメータ:

doc - document

elm - このElementに追加される

name - 追加するElementの名前

戻り値:

追加されたElement

appendTextElement

public static Element appendTextElement(Document doc,
                                        Element elm,
                                        String name,
                                        String text)

Elementに指定タグ名のテキストElementを追加する.

テキストElementを追加します。テキストにはHTMLエスケープ が施されます。
次の作業に相当します。

---
  Element ee= doc.createElement(name);
  ee.appendChild(doc.createTextNode(text));
  elm.appendChild(ee);
  //return ee;

パラメータ:

doc - document

elm - このElementに追加される

name - 追加するテキストElementの名前

text - 追加するテキスト

戻り値:

追加されたテキストElement

getAttributes

public static HashMap<String,String> getAttributes(Element elm_)

Elementの全attributeを取得する。

次の操作に相当します。

   HashMap<String,String> attrs    = new HashMap<String,String>();
   NamedNodeMap           _attList = elm_.getAttributes();
   for (int i=0; i<_attList.getLength(); i++) {
      Attr _att = (Attr)_attList.item(i);
      attrs.put(_att.getName(),_att.getValue());
      }

パラメータ:

elm_ - Element

戻り値:

attribute辞書。名前がキー

setAttributes

public static void setAttributes(Element elm_,
                                 HashMap<String,String> attrs_)

Elementに複数のattributeを設定する

パラメータ:

elm_ - Element

attrs_ - attributeセット、キーはattribute名

appendElement

public static Element appendElement(Element to_,
                                    Element elm_)

他Documentからのelementを取り込む。

次の操作と同等です

         _doc= to_.getOwnerDocument();
         Node node= _doc.importNode(elm_,true);
         to_.appendChild(node);

パラメータ:

to_ - このElementの要素として追加

elm_ - 取り込むElement

戻り値:

取り込んだElement