模块 jdk.xml.dom
包 org.w3c.dom.xpath

接口 XPathResult

public interface XPathResult
XPathResult 接口表示在特定节点的上下文中对 XPath 1.0 表达式求值的结果。由于对 XPath 表达式的求值会产生各种结果类型，因此该对象使得发现和操作结果的类型和值成为可能。

另见 文档对象模型 (DOM) 级别 3 XPath 规范 。

  • 字段摘要

    字段
    修饰符和类型
    Field
    描述
    static final short
    ANY_TYPE
    此代码不代表特定类型。
    static final short
    ANY_UNORDERED_NODE_TYPE
    结果是一个由 定义的节点集，并将作为单个节点访问，如果节点集为空，则可能是 null。
    static final short
    BOOLEAN_TYPE
    结果是由 定义的boolean。
    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
      结果是由 定义的boolean。文档修改不会使boolean无效，但可能意味着重新评估不会产生相同的boolean。
      参见：

    • 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 并且自返回此结果后文档已被修改，则为真。

    • 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 或 null 中第 index 位置的节点，如果那不是有效索引。
      抛出：
      XPathException - TYPE_ERR：如果 resultType 不是 UNORDERED_NODE_SNAPSHOT_TYPE 或 ORDERED_NODE_SNAPSHOT_TYPE 则引发。