javax.xml.xpath

インタフェース XPathExpression

public interface XPathExpression

XPathExpression はコンパイルされた XPath 式へのアクセスを提供します。

XPath 式の評価。
コンテキスト	コンテキスト項目がない式を評価する要求が行われた場合、コンテキストには空のドキュメントノードが使用される。XPath 式を評価するため、DocumentFragment がドキュメントノードと同様に扱われる。
変数	式に変数の参照が含まれる場合、XPathVariableResolver によってその値が見つけられる。変数リゾルバが定義されていないか、リゾルバから変数に対して null が返された場合、XPathExpressionException が生成される。変数の値は、1 回の評価の過程を通じて不変でなければならない。
関数	式に関数の参照が含まれる場合、XPathFunctionResolver によって関数が見つけられる。関数リゾルバが定義されていないか、関数リゾルバから関数に対して null が返された場合、XPathExpressionException が生成される。
QName	式の中の QName が XPath 名前空間コンテキストに照らして解決される。
結果	式の評価の結果は目的の戻り値の型のインスタンスに変換される。有効な戻り値の型は、XPathConstants に定義する。戻り値の型への変換は XPath 変換規則に従う。

XPath 式はスレッドに対して安全ではなく、再入不可能です。つまり、アプリケーション側で、どのような場合でも 1 つの XPathExpression オブジェクトが複数のスレッドから使用されることがないようにする必要があります。また、evaluate メソッドが呼び出されている間、アプリケーションは再帰的に evaluate メソッドを呼び出すことができません。

導入されたバージョン:

1.5

関連項目:

XML Path Language (XPath) Version 1.0, Expressions

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	evaluate(InputSource source) 指定された InputSource のコンテキストでコンパイル済みの XPath 式を評価し、結果を String として返します。
Object	evaluate(InputSource source, QName returnType) 指定された InputSource のコンテキストでコンパイル済みの XPath 式を評価し、結果を指定された型として返します。
String	evaluate(Object item) 指定されたコンテキストでコンパイル済みの XPath 式を評価し、結果を String として返します。
Object	evaluate(Object item, QName returnType) 指定されたコンテキストでコンパイル済みの XPath 式を評価し、結果を指定された型として返します。

メソッドの詳細

evaluate

Object evaluate(Object item,
              QName returnType)
                throws XPathExpressionException

指定されたコンテキストでコンパイル済みの XPath 式を評価し、結果を指定された型として返します。

コンテキスト項目の評価、変数、関数、および QName の解決と戻り値の型の変換については「XPath 式の評価」を参照してください。

returnType が XPathConstants に定義された型でない場合、IllegalArgumentException がスローされます。

item に null 値が指定される場合、コンテキストには空のドキュメントが使用されます。returnType が null の場合、NullPointerException がスローされます。

パラメータ:

item - 開始コンテキスト (ノードなど)。

returnType - 目的の戻り値の型。

戻り値:

式を評価し、結果を returnType に変換した結果である Object。

例外:

XPathExpressionException - 式を評価できない場合。

IllegalArgumentException - returnType が XPathConstants に定義された型でない場合。

NullPointerException - returnType が null の場合。

evaluate

String evaluate(Object item)
                throws XPathExpressionException

指定されたコンテキストでコンパイル済みの XPath 式を評価し、結果を String として返します。

このメソッドは、XPathConstants.STRING の returnType を指定して evaluate(Object item, QName returnType) を呼び出します。

コンテキスト項目の評価、変数、関数、および QName の解決と戻り値の型の変換については「XPath 式の評価」を参照してください。

item に null 値が指定される場合、コンテキストには空のドキュメントが使用されます。

パラメータ:

item - 開始コンテキスト (ノードなど)。

戻り値:

式を評価し、結果を String に変換した結果である String。

例外:

XPathExpressionException - 式を評価できない場合。

evaluate

Object evaluate(InputSource source,
              QName returnType)
                throws XPathExpressionException

指定された InputSource のコンテキストでコンパイル済みの XPath 式を評価し、結果を指定された型として返します。

このメソッドは InputSource のデータモデルを構築し、結果として得られるドキュメントオブジェクトに対して evaluate(Object item, QName returnType) を呼び出します。

コンテキスト項目の評価、変数、関数、および QName の解決と戻り値の型の変換については「XPath 式の評価」を参照してください。

returnType が XPathConstants に定義された型でない場合、IllegalArgumentException がスローされます。

source または returnType が null の場合、NullPointerException がスローされます。

パラメータ:

source - 評価するドキュメントの InputSource。

returnType - 目的の戻り値の型。

戻り値:

式を評価し、結果を returnType に変換した結果である Object。

例外:

XPathExpressionException - 式を評価できない場合。

IllegalArgumentException - returnType が XPathConstants に定義された型でない場合。

NullPointerException - source または returnType が null の場合。

evaluate

String evaluate(InputSource source)
                throws XPathExpressionException

指定された InputSource のコンテキストでコンパイル済みの XPath 式を評価し、結果を String として返します。

このメソッドは、XPathConstants.STRING の returnType を指定して evaluate(InputSource source, QName returnType) を呼び出します。

コンテキスト項目の評価、変数、関数、および QName の解決と戻り値の型の変換については「XPath 式の評価」を参照してください。

source が null の場合、NullPointerException がスローされます。

パラメータ:

source - 評価するドキュメントの InputSource。

戻り値:

式を評価し、結果を String に変換した結果である String。

例外:

XPathExpressionException - 式を評価できない場合。

NullPointerException - source が null の場合。