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

インタフェースNodeFilter

既知のすべてのサブインタフェース:
LSSerializerFilter
public interface NodeFilter
フィルタは、ノードを「フィルタ処理する」方法を知っているオブジェクトです。 NodeIteratorまたはTreeWalkerにNodeFilterを指定した場合、次のノードが返される前にそのフィルタが適用されます。 フィルタが次のノードを受け入れるように指定すると、トラバーサルのロジックがそのノードを返します。そうでない場合、トラバーサルは次のノードを検索し、拒否されたノードが存在していなかったように振る舞います。

DOMはフィルタを一切提供しません。 NodeFilterは、ユーザーが独自のフィルタを提供するために実装可能なインタフェースにすぎません。

NodeFilterは、ノード間をトラバースする方法を認識している必要はなく、トラバースされているデータ構造についても認識している必要はありません。 フィルタは、単一のノードを評価する方法だけを認識しておけば良いので、フィルタを記述するのはきわめて容易です。 複数の種類の異なるトラバーサルで1つのフィルタを使用できるので、コードの再利用をお勧めします。

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

導入されたバージョン:
9、DOMレベル2

  • フィールドのサマリー

    フィールド
    修飾子と型 フィールド 説明
    static short FILTER_ACCEPT
    ノードを受け入れます。
    static short FILTER_REJECT
    ノードを拒否します。
    static short FILTER_SKIP
    指定した単一のノードをスキップします。
    static int SHOW_ALL
    すべてのNodesを示します。
    static int SHOW_ATTRIBUTE
    Attrノードを示します。
    static int SHOW_CDATA_SECTION
    CDATASectionノードを示します。
    static int SHOW_COMMENT
    Commentノードを示します。
    static int SHOW_DOCUMENT
    Documentノードを示します。
    static int SHOW_DOCUMENT_FRAGMENT
    DocumentFragmentノードを示します。
    static int SHOW_DOCUMENT_TYPE
    DocumentTypeノードを示します。
    static int SHOW_ELEMENT
    Elementノードを示します。
    static int SHOW_ENTITY
    Entityノードを示します。
    static int SHOW_ENTITY_REFERENCE
    EntityReferenceノードを示します。
    static int SHOW_NOTATION
    Notationノードを示します。
    static int SHOW_PROCESSING_INSTRUCTION
    ProcessingInstructionノードを示します。
    static int SHOW_TEXT
    Textノードを示します。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    short acceptNode​(Node n)
    指定されたノードがTreeWalkerまたはNodeIteratorの論理ビューで可視であるかどうかをテストします。

  • フィールド詳細

    • FILTER_ACCEPT

      static final short FILTER_ACCEPT
      ノードを受け入れます。 NodeIteratorまたはTreeWalkerに定義されたナビゲーション・メソッドは、このノードを返します。
      関連項目:
      定数フィールド値

    • FILTER_REJECT

      static final short FILTER_REJECT
      ノードを拒否します。 NodeIteratorまたはTreeWalkerに定義されたナビゲーション・メソッドは、このノードを返しません。 TreeWalkerの場合、このノードの子も拒否されます。 NodeIteratorsは、このノードをFILTER_SKIPと同義として扱います。
      関連項目:
      定数フィールド値

    • FILTER_SKIP

      static final short FILTER_SKIP
      指定した単一のノードをスキップします。 NodeIteratorまたはTreeWalkerに定義されたナビゲーション・メソッドは、このノードを返しません。 NodeIteratorとTreeWalkerの両方で、このノードの子は引き続き考慮されます。
      関連項目:
      定数フィールド値

    • SHOW_ALL

      static final int SHOW_ALL
      すべてのNodesを示します。
      関連項目:
      定数フィールド値

    • SHOW_ELEMENT

      static final int SHOW_ELEMENT
      Elementノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_ATTRIBUTE

      static final int SHOW_ATTRIBUTE
      Attrノードを示します。 このフィールドは、属性ノードをrootとするNodeIteratorまたはTreeWalkerを生成するときにのみ有効です。この場合、属性ノードが反復処理またはトラバーサルの最初の位置に現れることを示します。 属性は、他のノードの子であることはないので、ドキュメント・ツリー上をトラバースするときに現れません。
      関連項目:
      定数フィールド値

    • SHOW_TEXT

      static final int SHOW_TEXT
      Textノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_CDATA_SECTION

      static final int SHOW_CDATA_SECTION
      CDATASectionノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_ENTITY_REFERENCE

      static final int SHOW_ENTITY_REFERENCE
      EntityReferenceノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_ENTITY

      static final int SHOW_ENTITY
      Entityノードを示します。 このフィールドは、EntityノードをrootとするNodeIteratorまたはTreeWalkerを生成するときにのみ有効です。この場合、Entityノードがトラバーサルの最初の位置に現れることを示します。 エンティティは、ドキュメント・ツリーの一部ではないので、ドキュメント・ツリー上をトラバースするときに現れません。
      関連項目:
      定数フィールド値

    • SHOW_PROCESSING_INSTRUCTION

      static final int SHOW_PROCESSING_INSTRUCTION
      ProcessingInstructionノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_COMMENT

      static final int SHOW_COMMENT
      Commentノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_DOCUMENT

      static final int SHOW_DOCUMENT
      Documentノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_DOCUMENT_TYPE

      static final int SHOW_DOCUMENT_TYPE
      DocumentTypeノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_DOCUMENT_FRAGMENT

      static final int SHOW_DOCUMENT_FRAGMENT
      DocumentFragmentノードを示します。
      関連項目:
      定数フィールド値

    • SHOW_NOTATION

      static final int SHOW_NOTATION
      Notationノードを示します。 このフィールドは、NotationノードをrootとするNodeIteratorまたはTreeWalkerを生成するときにのみ有効です。この場合、Notationノードがトラバーサルの最初の位置に現れることを示します。 表記法は、ドキュメント・ツリーの一部ではないので、ドキュメント・ツリー上をトラバースするときに現れません。
      関連項目:
      定数フィールド値

  • メソッドの詳細

    • acceptNode

      short acceptNode​(Node n)
      指定されたノードがTreeWalkerまたはNodeIteratorの論理ビューで可視であるかどうかをテストします。 この関数は、TreeWalkerとNodeIteratorの実装により呼び出され、通常はユーザー・コードから直接呼び出されることはありません。 (ただし、同じフィルタを使ってユーザー独自のアプリケーション論理を導く場合は、ユーザー・コードから直接呼び出すことも可能。)
      パラメータ:
      n - フィルタを通過するかどうかをチェックするノード。
      戻り値:
      前述のように、ノードの受け入れ、拒否、またはスキップを判定する定数。