compact2, compact3

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の場合。