1. ドキュメントオブジェクトモデル トラバース

1.1. 概要

この章はDOM レベル 2のTraversal オプション機能について説明する。 このTreeWalker、 NodeIterator、 NodeFilter のインターフェースは使いやすく頑丈なドキュメント内容の選択的なトラバース（横断解析）を提供する。

このセクションで見られるインターフェースは必須ではない。 DOMアプリケーションはDOMImplementationインターフェースのhasFeature(feature, version) メソッドを、パラメータ値"Traversal" および "2.0"に（それぞれ）指定して、このモジュールが実装によってサポートされているかどうかを決定することができる。 このモジュールを完全にサポートするためには、実装は DOM レベル 2 コア 仕様 [DOM Level 2 Core]で定義されている"Core"機能もサポートしなければならない。 適合性 に関する追加情報を、DOM レベル 2 コア 仕様 [DOM Level 2 Core]から参照して頂きたい。

NodeIterator とTreeWalker は、ドキュメントサブツリーのノードおよびそれらの存在する位置を表すための、2つの異なる方法である。 NodeIterator はサブツリーのフラットなビューを、ドキュメント順序に表れる、ノードの順序付きシーケンスとして提供する。このビューが階層構造を考慮せずに表現されるため、反復子が前後に移動するメソッドをもつが、上下に移動するものをもたないためである。 逆に、TreeWalker はサブツリーにおける階層構造関係を維持し、この階層構造におけるナビゲーションを可能にする。 一般的に、TreeWalker は選択されたノード周りのドキュメント構造を操作する仕事には向いており、 NodeIterator は選択されたノードのそれぞれの内容に焦点を当てた仕事に向いている。

NodeIterator とTreeWalkers はそれぞれ、ドキュメントサブツリーのビューを、そのサブツリー中で発見される全てのノードは含まない形で表現する。 この仕様では、これを論理ビュー と表現し、そのままのドキュメントサブツリーに該当する物理ビュー とは区別する。 反復子またはTreeWalker が生成されたとき、それは ノードフィルタと関連付けられていても良い。これはそれぞれのノードについて検証し、それが論理ビューの中で出現しても良いかどうかを決定する。さらに、どのノードタイプが論理ビューの中で発生して良いかを指定するフラグも用いられうる。

NodeIterator とTreeWalker は動的である - 論理ビューはもとのドキュメントに加えられた変更を反映する。 ただし、これらは、それらの変更にどう反応するかという点で異なるものになる。 ノードをシーケンシャルに表現するNodeIterator, は、そのシーケンスの内容が変化したときに、そのシーケンスにおける相対位置を維持するよう試みる。 ノードをフィルタされたツリーとして表現するTreeWalkerでは、 カレントノードからの相対位置を維持し、もしそれが新しいコンテキストに移動した時は、ノードをそれに繋げたままにする。以下で、それらの動作をもっと深く論じる。

    NodeIterator iter=
     ((DocumentTraversal)document).createNodeIterator(
          root, NodeFilter.SHOW_ELEMENT, null);

    while (Node n = iter.nextNode())
        printMe(n);
     

 * A B C D E F G H I

 [A] * B C D E F G H I

 * [A] B C D E F G H I

 * [A] B C D E F G H I

A B C [D] * E F G H I

A B C [D] * F G H I

A B C [D] * X F G H I

A B C [D] * I X F G H

A B C [D] * F G H I

A B [C] * F G H I

A B C D * [E] F G H I

A B C D * [F] G H I

A B C [D] * F G H I C （Cは不要？）

A B [C] * F G H I D

A B * [C]

A [B] *

A B C [D] * E F G H I D （最後のDは？重複？）

A [B] * G H I D

A [B] * c d E F G

A B c d [E] * F G

A B c [d] * F G

A B c X [d] * F G

    class NamedAnchorFilter implements NodeFilter
    {
     short acceptNode(Node n) {
      if (n.getNodeType()==Node.ELEMENT_NODE) {
       Element e = (Element)n;
       if (! e.getNodeName().equals("A"))
        return FILTER_SKIP;
      if (e.getAttributeNode("NAME") != null)
        return FILTER_ACCEPT;
       }
        return FILTER_SKIP;
      }
    }

NamedAnchorFilter myFilter = new NamedAnchorFilter(); 
NodeIterator iter=
     ((DocumentTraversal)document).createNodeIterator(
          node, NodeFilter.SHOW_ELEMENT, myFilter);
   

processMe(Node n) {
   nodeStartActions(n);
   for (Node child=n.firstChild(); 
        child != null;
        child=child.nextSibling()) {
      processMe(child);
   }
   nodeEndActions(n);
}

processMe(TreeWalker tw) {
   Node n = tw.getCurrentNode();
   nodeStartActions(tw);
   for (Node child=tw.firstChild(); 
        child!=null;
        child=tw.nextSibling()) {
      processMe(tw);
   }

   tw.setCurrentNode(n);
   nodeEndActions(tw);
}

class TablesInChapters implements NodeFilter {

   short acceptNode(Node n) {
      if (n.getNodeType()==Node.ELEMENT_NODE) {
    
          if (n.getNodeName().equals("CHAPTER"))
             return FILTER_ACCEPT;

          if (n.getNodeName().equals("TABLE"))
             return FILTER_ACCEPT;

          if (n.getNodeName().equals("SECT1")
              || n.getNodeName().equals("SECT2")
              || n.getNodeName().equals("SECT3")
              || n.getNodeName().equals("SECT4")
              || n.getNodeName().equals("SECT5")
              || n.getNodeName().equals("SECT6")
              || n.getNodeName().equals("SECT7"))
             return FILTER_SKIP;

      }

      return FILTER_REJECT;
    }
}

TablesInChapters tablesInChapters  = new TablesInChapters();
TreeWalker tw  = 
     ((DocumentTraversal)document).createTreeWalker(
          root, NodeFilter.SHOW_ELEMENT, tablesInChapters);
processMe(tw);

    ...
    <subtree>
        <twRoot>
            <currentNode/>
            <anotherNode/>
        </twRoot>
    </subtree>
    ...
 

    ...
    <subtree>
        <currentNode/>
        <twRoot>
            <anotherNode/>
        </twRoot>
    </subtree>
    ...

1.2. 形式的なインターフェース定義

インターフェース NodeIterator (DOM レベル 2で導入)

反復子 はノードのセットの間をステップするために用いる。たとえば、NodeList中のノードのセット、特定のNodeに結びつけられたドキュメントサブツリー、クエリの結果、あるいはその他のノードのセットなどがある。 反復子を指定されるノードのセットはNodeIteratorの実装によって決定される。 DOM レベル 2 では、ドキュメント順序でドキュメントサブツリーをトラバースするための単一のNodeIteratorの実装を規定している。 これらの反復子のインスタンスはDocumentTraversal.createNodeIterator()を呼び出すことによって生成される。

IDL 定義

// DOM レベル 2で導入:
interface NodeIterator {
  readonly attribute Node             root;
  readonly attribute unsigned long    whatToShow;
  readonly attribute NodeFilter       filter;
  readonly attribute boolean          expandEntityReferences;
  Node               nextNode()
                                        raises(DOMException);
  Node               previousNode()
                                        raises(DOMException);
  void               detach();
};

アトリビュート

expandEntityReferences boolean型, readonly

このフラグの値はエンティティ参照ノードである子が反復子に可視とされるかどうかを決定する。falseであれば、それらとそれらの子孫は拒絶される。 この拒絶はwhatToShow やフィルタよりも優先する事に注意。 また、これは現在では、NodeIterators が個別のノードをスキップするのではなく完全なサブツリーを拒絶する、唯一のシチュエーションであるということにも注意。

エンティティ参照が展開され、かつそのエンティティ参照ノード自身は表に出さないようなドキュメントのビューを作り出すためには、whatToShow フラグを用いてそのエンティティ参照ノードを隠し、そしてこの反復子を生成するときにexpandEntityReferences をtrueに設定する。 エンティティ参照ノードをもつがエンティティを展開しないようなドキュメントのビューを作り出すためには、whatToShow フラグを用いてエンティティ参照ノードを表示し、かつexpandEntityReferences をfalseにする。

filter NodeFilter型, readonly

ノードをふるいにかけるために用いるNodeFilter。

root Node型, readonly

生成時に指定されたNodeIterator のルートノード。

whatToShow unsigned long型, readonly

この属性はどのノードタイプが反復子を通して出現するかを決定する。 有効な定数のセットはNodeFilter インターフェースで定義されている。 whatToShow で受容されなかったノードはスキップされるが、それらの子はなお検証の対象となる。このスキップはフィルタよりも優先適用されることに注意。

メソッド

detach

そのNodeIterator を、反復子を指定されているセットから切り離し、計算中のリソースを解放してその反復子を INVALID 状態にする。 detach が呼び出された後は、nextNode あるいは previousNode の呼び出しは例外 INVALID_STATE_ERR を発生させる。

パラメータ なし

戻り値 なし

例外 なし

nextNode

セットにおける次のノードを返し、反復子の位置をそのセットの中で先に進める。NodeIterator が生成された後は、nextNode() の最初の呼び出しは、そのセット中で最初のノードを返す。

戻り値

Node	そのセット中で反復子を指定される次のNode か、もしそのセットにそれ以上のメンバーが存在しない場合はnull。

例外

DOMException

INVALID_STATE_ERR: このメソッドが、detach メソッドが呼び出された後に呼び出された場合に発生する。

パラメータ なし

previousNode

セットにおける前のノードを返し、NodeIteratorの位置をそのセットの中で前に戻す。

戻り値

Node	そのセット中で反復子を指定される前のNode か、もしそのセットにそれ以上のメンバーが存在しない場合はnull。

例外

DOMException

INVALID_STATE_ERR: このメソッドが、detach メソッドが呼び出された後に呼び出された場合に発生する。

パラメータ なし

インターフェース NodeFilter ( DOM レベル 2で導入)

フィルタはどのようにノードを「フィルタアウトするか」を知るオブジェクトである。NodeIterator あるいは TreeWalker にNodeFilterが与えられると、それは次のノードを返す前にこのフィルタを適用する。 もしこのフィルタがそのノードを受容すると言うのであれば、トラバースロジックはそれを返し、そうでなければトラバースは次のノードを探し、その拒絶されたノードはそこには存在しなかったかのように装う。

DOM は何らフィルタを提供しない。 NodeFilter は、ユーザーが実装して自身のフィルタを生成することができるような、単なるインターフェースである。

NodeFilters はどのようにノードからノードにトラバースするかを知る必要はないし、トラバースされることになるデータ構造について何ら知っている必要もない。知らなければならないのは単一のノードをどのように評価するかということだけなので、これはフィルタを非常に記述し易くしている。 1つのフィルタは多くのトラバースに用いられてもよく、コードの再利用を促進している。

IDL 定義

// DOM レベル 2で導入:
interface NodeFilter {

  // acceptNodeによって返される定数
  const short               FILTER_ACCEPT                  = 1;
  const short               FILTER_REJECT                  = 2;
  const short               FILTER_SKIP                    = 3;


  // whatToShowのための定数
  const unsigned long       SHOW_ALL                       = 0xFFFFFFFF;
  const unsigned long       SHOW_ELEMENT                   = 0x00000001;
  const unsigned long       SHOW_ATTRIBUTE                 = 0x00000002;
  const unsigned long       SHOW_TEXT                      = 0x00000004;
  const unsigned long       SHOW_CDATA_SECTION             = 0x00000008;
  const unsigned long       SHOW_ENTITY_REFERENCE          = 0x00000010;
  const unsigned long       SHOW_ENTITY                    = 0x00000020;
  const unsigned long       SHOW_PROCESSING_INSTRUCTION    = 0x00000040;
  const unsigned long       SHOW_COMMENT                   = 0x00000080;
  const unsigned long       SHOW_DOCUMENT                  = 0x00000100;
  const unsigned long       SHOW_DOCUMENT_TYPE             = 0x00000200;
  const unsigned long       SHOW_DOCUMENT_FRAGMENT         = 0x00000400;
  const unsigned long       SHOW_NOTATION                  = 0x00000800;

  short              acceptNode(in Node n);
};

定義グループ acceptNodeによって返される定数

以下の定数は acceptNode() メソッドによって返される:

定義済み定数

FILTER_ACCEPT

ノードを受容する。NodeIterator あるいは TreeWalker で定義されたナビゲーションメソッドはこのノードを返す。

FILTER_REJECT

ノードを拒絶する。NodeIterator あるいは TreeWalker で定義されたナビゲーションメソッドはこのノードを返さない。 TreeWalker, については、このノードの子もまた拒絶される。 NodeIterators はこれをFILTER_SKIPと同様に扱う。

FILTER_SKIP

この1つのノードをスキップする。NodeIterator あるいは TreeWalker で定義されたナビゲーションメソッドはこのノードを返さない。 NodeIterator と TreeWalker の両方とも、そのノードの子はなお検証の対象となる。

定義グループ whatToShowのための定数

これらはTreeWalkers および NodeIterators で利用されるwhatToShow パラメータの有効な値となる。 これらはNodeの有効なタイプのセットと同様であり、それらの値は 同じノードタイプのnodeType で該当する値のビット位置を用いて派生される。 もしwhatToShow のビットがfalseにセットされた場合、それはこのタイプのノードがスキップされるよう要求されていることを表す。その場合の動作はFILTER_SKIPのそれと同様である。

もし32種類以上のノードタイプが導入された場合、それらはそれぞれを whatToShowを通じてテストすることができない。 もしそのようなニーズが生じた場合、それはSHOW_ALL の選択と適切なNodeFilterによって扱われることで可能になる。

定義済み定数

SHOW_ALL

全てのNodesを表示する。

SHOW_ATTRIBUTE

Attr ノードを表示する。 これは反復子あるいはツリーウォーカーの生成時に、属性値をその rootとして指定した場合にのみ有効である。この場合、それはその属性ノードがその反復子あるいはトラバースの最初の位置に出現することを表す。 属性は他のノードの子にはなりえないので、それらはドキュメントツリーのトラバース中に出現することはない。

SHOW_CDATA_SECTION

CDATASection ノードを表示する。

SHOW_COMMENT

Comment ノードを表示する。

SHOW_DOCUMENT

Document ノードを表示する。

SHOW_DOCUMENT_FRAGMENT

DocumentFragment ノードを表示する。

SHOW_DOCUMENT_TYPE

DocumentType ノードを表示する。

SHOW_ELEMENT

Element ノードを表示する。

SHOW_ENTITY

Entity ノードを表示する。 これは反復子あるいはツリーウォーカーを、Entity ノードをそのrootとして生成した場合にのみ有効である。 この場合、これはこの Entity ノードがトラバースの最初の位置に出現することを意味する。 エンティティはドキュメントツリーの一部ではないため、それらはドキュメントツリーのトラバース中に出現することはない。

SHOW_ENTITY_REFERENCE

EntityReference ノードを表示する。

SHOW_NOTATION

Notation ノードを表示する。 これは反復子あるいはツリーウォーカーを、Notation ノードをそのrootとして生成した場合にのみ有効である。 この場合、これはこの Notation ノードがトラバースの最初の位置に出現することを意味する。 ノーテーションはドキュメントツリーの一部ではないため、それらはドキュメントツリーのトラバース中に出現することはない。

SHOW_PROCESSING_INSTRUCTION

ProcessingInstruction ノードを表示する。

SHOW_TEXT

Text ノードを表示する。

メソッド

acceptNode

指定されたノードがTreeWalker あるいは NodeIterator の論理ビューについて可視であるかどうかをテストする。 この関数はTreeWalker および NodeIteratorの実装によって呼び出される。 これは通常ユーザーのコードからは直接呼び出されない。（ただ、同じフィルタを用いてアプリケーションロジックをガイドしたいというのであれば、それは可能である。）

パラメータ

n Node型

このフィルタを通るかどうかチェックしたいノード。

戻り値

short

そのノードが受容されるか、拒絶されるか、スキップされるかを判別する定数。 上記の定義の通り。

例外 なし

インターフェース TreeWalker ( DOM レベル 2で導入)

TreeWalker オブジェクトはドキュメントツリーあるいはサブツリーを、whatToShow フラグと（もしあれば）フィルタとによって定義されたドキュメントのビューを用いてナビゲートするために用いられる。 TreeWalkerを用いたナビゲーションを実行する関数は、TreeWalkerで定義されたビューをサポートする。

サブツリーの論理ビューからノードを省略した結果は、同じサブツリーの、完全な、フィルタされていないドキュメントとは全く異なる構造となってもよい。 TreeWalker 上で兄弟となっているものは、異なった、オリジナルビューにおけるばらばらのノードの子でありうる。 たとえば、Textノード以外の全てをスキップするようなNodeFilterと、ドキュメントのルートノードについて考えてみよう。 その結果の論理ビューでは、全てのテキストノードが兄弟 であり、たとえオリジナルドキュメントの構造中でどれだけ深い位置に存在していたとしても、そのルートノードの直下に出現する。

IDL 定義

// DOM レベル 2で導入:
interface TreeWalker {
  readonly attribute Node             root;
  readonly attribute unsigned long    whatToShow;
  readonly attribute NodeFilter       filter;
  readonly attribute boolean          expandEntityReferences;
           attribute Node             currentNode;
                                        // raises(DOMException) on setting

  Node               parentNode();
  Node               firstChild();
  Node               lastChild();
  Node               previousSibling();
  Node               nextSibling();
  Node               previousNode();
  Node               nextNode();
};

アトリビュート

currentNode Node型

TreeWalker が現在位置しているノード。
DOMツリーの置換はカレントノードがもはやTreeWalkerに関連付けられたフィルタによって受容されなくなるようになるかもしれない。 currentNode はそれがroot ノードによって指定されたサブツリー中に存在するかしないか、あるいはフィルタやwhatToShow フラグによって受容されるかどうか、といったことに関わりなく、明示的に任意のノードに指定されうる。 それ以上の解析は、リクエストされた方向でそのフィルタを適用された結果たとえcurrentNodeがカレントビューの一部でなくなったとしても、このcurrentNodeからの相対で発生する。 もし有効なトラバースが存在しない場合は、currentNode は変更されない。

セット時の例外

DOMException

NOT_SUPPORTED_ERR: currentNode がnullにセットされようとしたときに発生する。

expandEntityReferences boolean型, readonly

このフラグの値は、エンティティ参照ノードの子がTreeWalkerから可視とされるかどうかを決定する。 falseであれば、それらとそれらの子孫 は拒絶される。 この拒絶はwhatToShow および（もしあれば）フィルタより優先適用されることに注意。
展開されたエンティティ参照をもち、かつそのエンティティ参照ノードは表に出さないようなドキュメントのビューを作り出すためには、 whatToShow フラグをもちいてエンティティ参照ノードを隠し、TreeWalkerの生成時にexpandEntityReferences をtrueにセットすればよい。 エンティティ参照ノードを持つがエンティティは展開しないようなドキュメントのビューを作り出すためには、 whatToShow フラグを用いてエンティティ参照ノードを表示し、expandEntityReferences をfalseにセットすればよい。

filter NodeFilter型, readonly

ノードをふるいにかけるために用いられるフィルタ。

root Node型, readonly

生成時に指定されたTreeWalkerのroot ノード。

whatToShow unsigned long型, readonly

この属性はどのノードタイプがTreeWalkerを通して出現するかを決定する。有効な定数のセットはNodeFilter インターフェースで定義されている。 whatToShow で受容されないノードはスキップされるが、それらの子はなお検証の対象となる。このスキップは（もしあれば）フィルタより優先適用されることに注意。

メソッド

firstChild

TreeWalker をカレントノード中の最初の可視の子 に移動し、その新しいノードを返す。 もしカレントノードが可視の子をもたない場合はnullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューおける可視の子をもたない場合はnull。

パラメータ なし

例外 なし

lastChild

TreeWalker をカレントノード中の最後の可視の子 に移動し、その新しいノードを返す。 もしカレントノードが可視の子をもたない場合はnullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューおける可視の子をもたない場合はnull。

パラメータ なし

例外 なし

nextNode

TreeWalker をドキュメント順序でカレントノードから相対的に次にある可視ノードに移動し、新しいノードを返す。もしカレントノードに次のノードがない場合、あるいはnextNodeの検索がTreeWalkerのroot ノードより上に移動しようとした場合は、nullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューで次のノードをもたない場合はnull。

パラメータ なし

例外 なし

nextSibling

TreeWalker を次の兄弟に移動し、新しいノードを返す。もしカレントノードの次の可視兄弟がない場合はnullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューで次の兄弟をもたない場合はnull。

パラメータ なし

例外 なし

parentNode

カレントノードから最も近い可視の祖先 ノードに移動してそれを返す。 もしparentNode の検索がTreeWalkerのrootより上に移動しようとするか、可視の祖先 ノードが存在しない場合、このメソッドはカレント位置を保持し、nullを返す。

戻り値

Node	新しい親 ノード、あるいはもしカレントノードがTreeWalkerの論理ビューで親をもたない場合はnull。

パラメータ なし

例外 なし

previousNode

TreeWalker をドキュメント順序でカレントノードから相対的に前にある可視ノードに移動し、新しいノードを返す。もしカレントノードに次のノードがない場合、あるいはpreviousNodeの検索がTreeWalkerのroot ノードより上に移動しようとした場合は、nullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューで前のノードをもたない場合はnull。

パラメータ なし

例外 なし

previousSibling

TreeWalker を前の兄弟に移動し、新しいノードを返す。もしカレントノードの前の可視兄弟がない場合はnullを返し、カレントノードを維持する。

戻り値

Node	新しいノード、あるいはもしカレントノードがTreeWalkerの論理ビューで前の兄弟をもたない場合はnull。

パラメータ なし

例外 なし

インターフェース DocumentTraversal (introduced in DOM Level 2)

DocumentTraversal は反復子とツリーウォーカーを生成してノードおよびその子をドキュメント順序でトラバースするメソッドを含む（最初の深さで、ドキュメントのテキスト表現において開始タグが出現した順序に等しい順序の規定されたトラバースとなる）。 Traversal featureをサポートするDOMでは、DocumentTraversal はDocumentインターフェースを実装しているものと同じオブジェクトによって実装される。

IDL 定義

// DOM レベル 2で導入:
interface DocumentTraversal {
  NodeIterator       createNodeIterator(in Node root, 
                                        in unsigned long whatToShow, 
                                        in NodeFilter filter, 
                                        in boolean entityReferenceExpansion)
                                        raises(DOMException);
  TreeWalker         createTreeWalker(in Node root, 
                                      in unsigned long whatToShow, 
                                      in NodeFilter filter, 
                                      in boolean entityReferenceExpansion)
                                        raises(DOMException);
};

メソッド

createNodeIterator

指定されたノードをサブツリーのルートとする、新しいNodeIteratorを生成する。

パラメータ

root Node型

その子ともども反復子を指定されるノード。この反復子は最初はこのノードの前に位置する。 whatToShow フラグおよび（もしあれば）フィルタは、この位置をセットする際には考慮されない。ルートはnullであってはならない。

whatToShow unsigned long型

このフラグはどのノードタイプがこの反復子によって表示されるツリーの論理ビューによって出現してもよいかを指定する。 NodeFilter の有効なSHOW_ の値のセットに関する説明を参照。
これらのフラグはORを用いて結合されうる。

filter NodeFilter型

このTreeWalker（NodeIteratorでは？）で用いられる NodeFilter 、あるいはフィルタを指定しない場合はnull。

entityReferenceExpansion boolean型

このフラグの値はエンティティ参照ノードが展開されるかどうかを決定する。

戻り値

NodeIterator

新たに生成されたNodeIterator。

例外

DOMException

NOT_SUPPORTED_ERR: 指定されたroot が nullであった場合に発生する。

createTreeWalker

指定されたノードをサブツリーのルートとする、新しいTreeWalkerを生成する。

パラメータ

root Node型

TreeWalker のrootとして使用されるノード。 whatToShow フラグおよびNodeFilter はこの値を設定するときには考慮されない。いかなるタイプのノードもrootとして許容される。 TreeWalker のcurrentNodeは、それが可視であるかないかを問わず、このノードに初期化される。 root はparentNode あるいは nextNode のようなドキュメント構造を上に探すようなトラバースメソッドにおいて、ストップ位置として機能する。 root はnullであってはならない。

whatToShow unsigned long型

このフラグはどのノードタイプがツリーウォーカーによるツリーの論理ビューで出現してよいかを決定する。 NodeFilter の有効なSHOW_ の値に関する説明を参照。
これらのフラグはORを用いて結合されうる。

filter NodeFilter型

このTreeWalkerで使用されるNodeFilter、あるいはフィルタを指定しない場合はnull。

entityReferenceExpansion boolean型

もしこのフラグがfalseであれば、EntityReference ノードの内容は論理ビュー中で出現しない。

戻り値

TreeWalker

新しく生成されたTreeWalker.

例外

DOMException

NOT_SUPPORTED_ERR: 指定された root が nullであった場合に発生する。