モジュール jdk.xml.dom

パッケージ org.w3c.dom.xpath

インタフェースXPathResult

public interface XPathResult

XPathResultインタフェースは、特定のノードのコンテキスト内でXPath 1.0式を評価した結果を表します。 XPath式を評価すると様々な結果タイプになる可能性があるため、このオブジェクトにより、結果の型と値の検出および操作が可能になります。

「ドキュメント・オブジェクト・モデル(DOM)レベル3 XPath仕様」も参照してください。

導入されたバージョン:

1.4、DOMレベル3

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final short	ANY_TYPE	このコードは特定の型を表していません。
static final short	ANY_UNORDERED_NODE_TYPE	結果は、定義したノード・セットであり、単一ノードとしてアクセスされます。ノード・セットが空の場合、nullになります。
static final short	BOOLEAN_TYPE	結果はで定義されたブール値です。
static final short	FIRST_ORDERED_NODE_TYPE	結果は、定義したノード・セットであり、単一ノードとしてアクセスされます。ノード・セットが空の場合、nullになります。
static final short	NUMBER_TYPE	結果はで定義された数です。
static final short	ORDERED_NODE_ITERATOR_TYPE	その結果、定義したノード・セットが反復的にアクセスされ、ドキュメント順序のノードが生成されます。
static final short	ORDERED_NODE_SNAPSHOT_TYPE	その結果、定義したノード・セットが、元のドキュメント順になるノードのスナップショット・リストとしてアクセスされます。
static final short	STRING_TYPE	結果はで定義された文字列です。
static final short	UNORDERED_NODE_ITERATOR_TYPE	結果は、それによって定義されたノード・セットが反復的にアクセスされ、特定の順序でノードが生成されない場合があります。
static final 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バインディングのネイティブdouble型が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でない場合に発生します。