org.w3c.dom.traversal
インタフェース DocumentTraversal

public interface DocumentTraversal

DocumentTraversal には、NodeIterators と TreeWalkers を作成してドキュメント順にノードとノードの子をトラバースするメソッドがあります (深さ優先の行きがけ順トラバーサル、ドキュメントのテキスト表現で開始タグが発生する順序と同じ)。Traversal 機能をサポートする DOM では、DocumentTraversal は Document インタフェースを実装するオブジェクトと同じオブジェクトにより実装されます。

「Document Object Model (DOM) Level 2 Traversal and Range Specification」も参照してください。

導入されたバージョン:

DOM Level 2

メソッドの概要

NodeIterator	createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) 指定されたノードをルートとするサブツリー上に新規 NodeIterator を生成します。
TreeWalker	createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) 指定されたノードをルートとするサブツリー上に新規の TreeWalker を生成します。

メソッドの詳細

createNodeIterator

NodeIterator createNodeIterator(Node root,
                                int whatToShow,
                                NodeFilter filter,
                                boolean entityReferenceExpansion)
                                throws DOMException

指定されたノードをルートとするサブツリー上に新規 NodeIterator を生成します。

パラメータ:

root - 子と一緒に繰り返し処理されるノード。NodeIterator は、最初はこのノードのすぐ前に配置される。この位置を設定するとき、whatToShow フラグとフィルタは存在しても考慮されない。ルートは null であってはならない

whatToShow - このフラグは NodeIterator によって表されたツリーの論理ビューに表示可能なノードの型を指定する。可能な SHOW_ 値のセットについては、NodeFilter の説明を参照。フラグは OR を使って結合できる

filter - この NodeIterator とともに使用される NodeFilter、 フィルタを指定しない場合は null

entityReferenceExpansion - このフラグの値は、実体参照ノードが展開されるかどうかを判定する

戻り値:

新規生成された NodeIterator

例外:

DOMException - NOT_SUPPORTED_ERR:指定された root が null の場合に発生する

createTreeWalker

TreeWalker createTreeWalker(Node root,
                            int whatToShow,
                            NodeFilter filter,
                            boolean entityReferenceExpansion)
                            throws DOMException

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

パラメータ:

root - TreeWalker のroot として機能するノード。whatToShow フラグと NodeFilter は、この値を設定するとき考慮されない。任意のノード型が root として受け入れられる。TreeWalker の currentNode は、可視であるかどうかにかかわらずこのノードに初期化される。root は、parentNode や nextNode など、ドキュメント構造で上に向かって検出するトラバーサルメソッドの停止点として機能する。root は null であってはならない

whatToShow - このフラグは TreeWalker によって表されたツリーの論理ビューに表示可能なノードの型を指定する。可能な SHOW_ 値のセットについては、NodeFilter の説明を参照。フラグは OR を使って結合できる

filter - この NodeIterator とともに使用される TreeWalker、フィルタを指定しない場合は null

entityReferenceExpansion - このフラグが false の場合、EntityReference ノードの内容は論理ビューに表示されない

戻り値:

新規生成された TreeWalker

例外:

DOMException - NOT_SUPPORTED_ERR:指定された root が null の場合に発生する