共通 DOM API

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

既知のサブインタフェースの一覧:
LSSerializerFilter

public interface NodeFilter

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

DOM はフィルタを提供しません。NodeFilter は、ユーザーが独自のフィルタを利用するために実装できる単なるインタフェースです。 

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

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

導入されたバージョン:
DOM Level 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 に定義されたナビゲーションメソッドは、このノードを返しません。NodeIteratorTreeWalker の両方で、このノードの子は引き続き考慮されます。

関連項目:
定数フィールド値

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 の論理ビューで可視であるかどうかをテストします。この関数は、TreeWalkerNodeIterator の実装により呼び出されます。通常、ユーザーコードから直接呼び出されることはありません (ただし、同じフィルタを使ってユーザー独自のアプリケーション論理を導く場合は、ユーザーコードから直接呼び出すことも可能)。

パラメータ:
n - フィルタを通過するかどうかをチェックするノード
戻り値:
前述のように、ノードの受け入れ、拒否、またはスキップを判定する定数

共通 DOM API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 2006 Sun Microsystems, Inc. 4150 Network Circle
Santa Clara, California, 95054, U.S.A. All Rights Reserved.