-
public interface XPathResult
XPathResult
インタフェースは、特定のノードのコンテキスト内のXPath 1.0式の評価結果を表します。 XPath式の評価はさまざまな結果型をもたらす可能性があるため、このオブジェクトを使用すると、結果の型と値を発見して操作することができます。「ドキュメント・オブジェクト・モデル(DOM)レベル3 XPath仕様」も参照してください。
-
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static short
ANY_TYPE
このコードは特定の型を表していません。static short
ANY_UNORDERED_NODE_TYPE
その結果、ノードセットが定義されており、ノードセットが空の場合はnull
である単一ノードとしてアクセスされます。static short
BOOLEAN_TYPE
結果はで定義されたブール値です。static short
FIRST_ORDERED_NODE_TYPE
その結果、ノードセットが定義されており、ノードセットが空の場合はnull
である単一ノードとしてアクセスされます。static short
NUMBER_TYPE
結果はで定義された数です。static short
ORDERED_NODE_ITERATOR_TYPE
結果は、それによって定義されるノード集合が反復的にアクセスされ、文書順ノードが生成されます。static short
ORDERED_NODE_SNAPSHOT_TYPE
結果は、元の文書順になるノードのスナップショット・リストとしてアクセスされるノードセットによって定義されるように設定されます。static short
STRING_TYPE
結果はで定義された文字列です。static short
UNORDERED_NODE_ITERATOR_TYPE
結果は、それによって定義されるノード集合が反復的にアクセスされ、特定の順序でノードを生成しないことがあります。static short
UNORDERED_NODE_SNAPSHOT_TYPE
その結果、特定の順序にないノードのスナップショット・リストとしてアクセスされるノードセットが定義されます。
-
メソッドのサマリー
修飾子と型 メソッド 説明 boolean
getBooleanValue()
このブール結果の値。boolean
getInvalidIteratorState()
イテレータが無効になったことを示します。double
getNumberValue()
この数値の値が返されます。short
getResultType()
型定数で定義されているこの結果の型を表すコード。Node
getSingleNodeValue()
この単一ノードの結果の値は、null
です。int
getSnapshotLength()
結果スナップショット内のノード数。String
getStringValue()
この文字列の結果の値。Node
iterateNext()
ノードセットから次のノードを反復して返します。ノードがない場合はnull
を返します。Node
snapshotItem(int index)
スナップショット・コレクション内のindex
番目のアイテムを返します。
-
-
-
フィールドの詳細
-
ANY_TYPE
static final short ANY_TYPE
このコードは特定の型を表していません。 XPath式の評価では、この型は決して生成されません。 この型がリクエストされた場合、評価は自然に式の評価から生じる型を返します。ANY_TYPE
がリクエストされたときに自然結果がノードセットである場合、UNORDERED_NODE_ITERATOR_TYPE
は常に結果の型です。 ノード集合の他の表現は明示的にリクエストされなければなりません。- 関連項目:
- 定数フィールド値
-
NUMBER_TYPE
static final short NUMBER_TYPE
結果はで定義された数です。 文書の変更によって番号が無効になることはありませんが、再評価によって同じ番号が返されることはありません。- 関連項目:
- 定数フィールド値
-
STRING_TYPE
static final short STRING_TYPE
結果はで定義された文字列です。 ドキュメントの変更は文字列を無効にしませんが、文字列が現在のドキュメントに対応しなくなる可能性があります。- 関連項目:
- 定数フィールド値
-
BOOLEAN_TYPE
static final short BOOLEAN_TYPE
結果はで定義されたブール値です。 ドキュメントの変更によってブール値が無効になることはありませんが、再評価によって同じブール値が返されることはありません。- 関連項目:
- 定数フィールド値
-
UNORDERED_NODE_ITERATOR_TYPE
static final short UNORDERED_NODE_ITERATOR_TYPE
結果は、それによって定義されるノード集合が反復的にアクセスされ、特定の順序でノードを生成しないことがあります。 文書の変更は反復を無効にします。
結果がノードセットであり、ANY_TYPE
がリクエストされた場合に返されるデフォルトの型です。- 関連項目:
- 定数フィールド値
-
ORDERED_NODE_ITERATOR_TYPE
static final short ORDERED_NODE_ITERATOR_TYPE
結果は、それによって定義されるノード集合が反復的にアクセスされ、文書順ノードが生成されます。 文書の変更は反復を無効にします。- 関連項目:
- 定数フィールド値
-
UNORDERED_NODE_SNAPSHOT_TYPE
static final short UNORDERED_NODE_SNAPSHOT_TYPE
その結果、特定の順序にないノードのスナップショット・リストとしてアクセスされるノードセットが定義されます。 ドキュメントの変更はスナップショットを無効にしませんが、再評価によって同じスナップショットが生成されず、スナップショット内のノードが変更、移動、またはドキュメントから削除された可能性があります。- 関連項目:
- 定数フィールド値
-
ORDERED_NODE_SNAPSHOT_TYPE
static final short ORDERED_NODE_SNAPSHOT_TYPE
結果は、元の文書順になるノードのスナップショット・リストとしてアクセスされるノードセットによって定義されるように設定されます。 ドキュメントの変更はスナップショットを無効にしませんが、再評価によって同じスナップショットが生成されず、スナップショット内のノードが変更、移動、またはドキュメントから削除された可能性があります。- 関連項目:
- 定数フィールド値
-
ANY_UNORDERED_NODE_TYPE
static final short ANY_UNORDERED_NODE_TYPE
その結果、ノードセットが定義されており、ノードセットが空の場合はnull
である単一ノードとしてアクセスされます。 ドキュメントの変更はノードを無効にしませんが、結果ノードが現在のドキュメントに対応しなくなる可能性があります。 これは、最適化を可能にする利便性です。なぜなら、結果セット内の任意のノードが見つかると実装が停止することができるからである。
実際の結果に複数のノードがある場合、返される単一のノードはドキュメント順では最初のノードではない可能性があります。- 関連項目:
- 定数フィールド値
-
FIRST_ORDERED_NODE_TYPE
static final short FIRST_ORDERED_NODE_TYPE
その結果、ノードセットが定義されており、ノードセットが空の場合はnull
である単一ノードとしてアクセスされます。 ドキュメントの変更はノードを無効にしませんが、結果ノードが現在のドキュメントに対応しなくなる可能性があります。 これは、最適化を可能にする便利な機能です。これは、結果セットのドキュメント・オーダーの最初のノードが見つかったら実装が停止できるためです。
実際の結果に複数のノードがある場合、返される単一のノードはドキュメント順の最初のノードになります。- 関連項目:
- 定数フィールド値
-
-
メソッドの詳細
-
getResultType
short getResultType()
型定数で定義されているこの結果の型を表すコード。
-
getNumberValue
double getNumberValue() throws XPathException
この数値の値が返されます。 DOMバインディングのネイティブ・ダブル型がXPath式の正確なIEEE 754結果を直接サポートしていない場合は、バインディング・バインディングの定義に従ってXPath番号をネイティブ・バインディング番号に変換する方法を指定します。- 例外:
XPathException
- TYPE_ERR:resultType
がNUMBER_TYPE
でない場合に発生します。
-
getStringValue
String getStringValue() throws XPathException
この文字列の結果の値。- 例外:
XPathException
- TYPE_ERR:resultType
がSTRING_TYPE
でない場合に発生します。
-
getBooleanValue
boolean getBooleanValue() throws XPathException
このブール結果の値。- 例外:
XPathException
- TYPE_ERR:resultType
がBOOLEAN_TYPE
でない場合に発生します。
-
getSingleNodeValue
Node getSingleNodeValue() throws XPathException
この単一ノードの結果の値は、null
です。- 例外:
XPathException
- TYPE_ERR:resultType
がANY_UNORDERED_NODE_TYPE
またはFIRST_ORDERED_NODE_TYPE
でない場合に発生します。
-
getInvalidIteratorState
boolean getInvalidIteratorState()
イテレータが無効になったことを示します。resultType
がUNORDERED_NODE_ITERATOR_TYPE
またはORDERED_NODE_ITERATOR_TYPE
であり、この結果が返されたために文書が変更されている場合はtrue。
-
getSnapshotLength
int getSnapshotLength() throws XPathException
結果スナップショット内のノード数。 snapshotItemインデックスの有効な値は、0
〜snapshotLength-1
です。- 例外:
XPathException
- TYPE_ERR:resultType
がUNORDERED_NODE_SNAPSHOT_TYPE
またはORDERED_NODE_SNAPSHOT_TYPE
でない場合に発生します。
-
iterateNext
Node iterateNext() throws XPathException, DOMException
ノードセットから次のノードを反復して返します。ノードがない場合はnull
を返します。- 戻り値:
- 次のノードを返します。
- 例外:
XPathException
- TYPE_ERR:resultType
がUNORDERED_NODE_ITERATOR_TYPE
またはORDERED_NODE_ITERATOR_TYPE
でない場合に発生します。DOMException
- INVALID_STATE_ERR: 結果が返されたため、ドキュメントに変更がありました。
-
snapshotItem
Node snapshotItem(int index) throws XPathException
スナップショット・コレクション内のindex
番目のアイテムを返します。index
がリスト内のノードの数以上である場合、このメソッドはnull
を返します。 イテレータの結果とは異なり、スナップショットは無効にはなりませんが、変更されている場合は現在のドキュメントに対応しない可能性があります。- パラメータ:
index
- スナップショット・コレクションのインデックスを作成します。- 戻り値:
NodeList
内のindex
番目の位置にあるノード。それが有効なインデックスでない場合はnull
。- 例外:
XPathException
- TYPE_ERR:resultType
がUNORDERED_NODE_SNAPSHOT_TYPE
またはORDERED_NODE_SNAPSHOT_TYPE
でない場合に発生します。
-
-