モジュール java.xml
パッケージ org.w3c.dom.traversal

インタフェースDocumentTraversal

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

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

導入されたバージョン:
9、DOMレベル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 - このTreeWalkerとともに使用されるNodeFilter、フィルタを指定しない場合はnull。
      entityReferenceExpansion - このフラグがfalseの場合、EntityReferenceノードの内容は論理ビューに表示されない。
      戻り値:
      新しく作成されたTreeWalker。
      例外:
      DOMException - NOT_SUPPORTED_ERR: 指定されたrootがnullの場合に発生する。