Module  jdk.xml.dom
软件包  org.w3c.dom.xpath

Interface XPathResult


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

    另见Document Object Model (DOM) Level 3 XPath Specification 。

    • 字段详细信息

      • ANY_TYPE

        static final short ANY_TYPE
        此代码不代表特定类型。 对XPath表达式的评估将永远不会产生此类型。 如果请求此类型，则评估返回自然会从表达式的评估中产生的任何类型。
        如果自然结果是节点组时ANY_TYPE请求，然后UNORDERED_NODE_ITERATOR_TYPE总是得到的类型。 必须明确请求节点集的任何其他表示形式。
        另请参见：
        Constant Field Values

      • NUMBER_TYPE

        static final short NUMBER_TYPE
        结果是定义的数字。 文件修改不会使数字无效，但可能意味着重新评估不会产生相同的数字。
        另请参见：
        Constant Field Values

      • STRING_TYPE

        static final short STRING_TYPE
        结果是一个字符串定义。 文档修改不会使字符串无效，但可能意味着字符串不再对应于当前文档。
        另请参见：
        Constant Field Values

      • BOOLEAN_TYPE

        static final short BOOLEAN_TYPE
        结果是一个布尔值。 文档修改不会使布尔值无效，但可能意味着重新评估不会产生相同的布尔值。
        另请参见：
        Constant Field Values

      • UNORDERED_NODE_ITERATOR_TYPE

        static final short UNORDERED_NODE_ITERATOR_TYPE
        结果是由定义的节点集将被迭代地访问，这可能不以特定顺序产生节点。 文档修改使迭代无效。
        如果结果是一个节点集， ANY_TYPE请求了ANY_TYPE这是返回的默认类型。
        另请参见：
        Constant Field Values

      • ORDERED_NODE_ITERATOR_TYPE

        static final short ORDERED_NODE_ITERATOR_TYPE
        结果是由定义的节点集将被迭代地访问，这将产生文档排序的节点。 文档修改使迭代无效。
        另请参见：
        Constant Field Values

      • UNORDERED_NODE_SNAPSHOT_TYPE

        static final short UNORDERED_NODE_SNAPSHOT_TYPE
        结果是由其定义的节点集将作为可能不是特定顺序的节点的快照列表被访问。 文档修改不会使快照无效，但可能意味着重新评估不会产生相同的快照，并且快照中的节点可能已被更改，移动或从文档中删除。
        另请参见：
        Constant Field Values

      • ORDERED_NODE_SNAPSHOT_TYPE

        static final short ORDERED_NODE_SNAPSHOT_TYPE
        结果是由定义的节点集将被作为将以原始文档顺序的节点的快照列表来访问。 文档修改不会使快照无效，但可能意味着重新评估不会产生相同的快照，并且快照中的节点可能已被更改，移动或从文档中删除。
        另请参见：
        Constant Field Values

      • ANY_UNORDERED_NODE_TYPE

        static final short ANY_UNORDERED_NODE_TYPE
        结果是由单个节点定义并将被访问的节点集，如果节点集为空，则可以是null 。 文档修改不会使节点无效，但可能意味着结果节点不再对应于当前文档。 这是一种允许优化的便利，因为一旦发现结果集中的任何节点就可以停止实现。
        如果实际结果中有多个节点，返回的单个节点可能不是文档顺序的第一个。
        另请参见：
        Constant Field Values

      • FIRST_ORDERED_NODE_TYPE

        static final short FIRST_ORDERED_NODE_TYPE
        结果是由一个节点定义并将被访问的节点集，如果节点集为空，则可以是null 。 文档修改不会使节点无效，但可能意味着结果节点不再对应于当前文档。 这是一种允许优化的便利，因为一旦发现结果集的文档顺序的第一个节点就可以停止实现。
        如果实际结果中有多个节点，返回的单个节点将按文档顺序排列。
        另请参见：
        Constant Field Values

    • 方法详细信息

      • getResultType

        short getResultType​()
        代表该结果类型的代码，由类型常量定义。

      • getNumberValue

        double getNumberValue​()
               throws XPathException
        这个数字的值结果。 如果本机双重类型的DOM绑定不直接支持XPath表达式的确切的IEEE 754结果，则由绑定绑定定义，以指定如何将XPath数转换为本机绑定号。
        异常
        XPathException - TYPE_ERR：如果 resultType不是 NUMBER_TYPE则 NUMBER_TYPE 。

      • getStringValue

        String getStringValue​()
               throws XPathException
        该字符串的值为result。
        异常
        XPathException - TYPE_ERR：如果 resultType不是 STRING_TYPE则 STRING_TYPE 。

      • getBooleanValue

        boolean getBooleanValue​()
                 throws XPathException
        这个布尔值的结果。
        异常
        XPathException - TYPE_ERR：如果 resultType不是 BOOLEAN_TYPE则 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 ， 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 - 索引到快照集合。
        结果
        节点在 index位置在 NodeList ，或 null如果那不是有效的索引。
        异常
        XPathException - TYPE_ERR：如果 resultType不是 UNORDERED_NODE_SNAPSHOT_TYPE或 ORDERED_NODE_SNAPSHOT_TYPE 。