Interface XPathQuery

All Known Implementing Classes:
AbstractXPathQuery, AllFromCurrentPositionXPathQuery, AllXPathQuery, FromCurrentPositionXPathQuery
public interface XPathQuery
This class represents an XPath expression query, ready for the execution on an XML DOM.

  • Method Summary

    Modifier and Type
    Method
    Description
    XPathQueryItem
    getFirstXPathQueryItem()
    Gets the first part of the XPath expression (usually the first element of the XPath string)
    String
    getQueryString()
    Gets a string representation of the XPath expression
    boolean
    isAll()
    Gets whether all descendants matching the XPath expression are to be returned.
    boolean
    isEmpty()
    Returns whether the XPath expression contains any XPath item definitions
    boolean
    isFromCurrentPosition()
    Gets whether the XPath expression execution starts from a node at the current position. if FALSE, the execution starts from the root element of the XML document.
    XPathQuery
    setNextItem(XPathQueryItem nextItem)
    Sets the next eu.europa.esig.dss.xml.common.definition.xpath.item.XPathItem as part of the XPath expression

  • Method Details

    • getFirstXPathQueryItem

      XPathQueryItem getFirstXPathQueryItem()
      Gets the first part of the XPath expression (usually the first element of the XPath string)
      Returns:
      XPathQueryItem

    • isAll

      boolean isAll()
      Gets whether all descendants matching the XPath expression are to be returned. If FALSE, only the children of the current element matching the XPath expression are extracted.
      Returns:
      whether all descendants matching the XPath expression are to be returned

    • isFromCurrentPosition

      boolean isFromCurrentPosition()
      Gets whether the XPath expression execution starts from a node at the current position. if FALSE, the execution starts from the root element of the XML document.
      Returns:
      whether the XPath expression execution starts from a node at the current position

    • isEmpty

      boolean isEmpty()
      Returns whether the XPath expression contains any XPath item definitions
      Returns:
      TRUE if the XPath expression is empty, FALSE otherwise

    • setNextItem

      XPathQuery setNextItem(XPathQueryItem nextItem)
      Sets the next eu.europa.esig.dss.xml.common.definition.xpath.item.XPathItem as part of the XPath expression
      Parameters:
      nextItem - XPathQueryItem to set
      Returns:
      this XPathQuery

    • getQueryString

      String getQueryString()
      Gets a string representation of the XPath expression
      Returns:
      String