モジュール jdk.xml.dom
パッケージ org.w3c.dom.xpath

インタフェースXPathResult

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

    Document Object Model (DOM) Level 3 XPath Specificationも参照してください。

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      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
      結果は、定義されたノード・セットであり、特定の順序ではない可能性があるノードのスナップショット・リストとしてアクセスされます。

    • フィールドの詳細

      • 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でない場合に発生します。