Class XPathQueryBuilder

java.lang.Object

eu.europa.esig.dss.xml.common.xpath.XPathQueryBuilder

public class XPathQueryBuilder
extends Object

Helper class for building an XPath expression query eu.europa.esig.dss.xml.common.xpath.XPathQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XPathQueryBuilder()	Empty constructor instantiating object with empty configuration

Method Summary

Modifier and Type	Method	Description
static XPathQueryBuilder	all()	Instantiates an XPath to search all element occurrences
XPathQueryBuilder	all(boolean all)	Defines if to search all element occurrences
static XPathQueryBuilder	allFromCurrentPosition()	Instantiates an XPath to search all element occurrences from the current position
XPathQueryBuilder	attribute(DSSAttribute attribute)	Defines the attribute to search.
XPathQueryBuilder	attribute(DSSAttribute attribute, String attributeValue)	Defines the attribute with the value to search.
XPathQuery	build()	Builds the XPath expression query
XPathQueryBuilder	element(DSSElement element)	Defines the element to search
XPathQueryBuilder	elements(DSSElement... elements)	Defines the element path to search
static XPathQueryBuilder	fromCurrentPosition()	Instantiates an XPath from the current position
XPathQueryBuilder	fromCurrentPosition(boolean fromCurrentPosition)	Defines if to start XPath from the current position
static XPathQueryBuilder	fromXPathQuery(XPathQuery xPathQuery)	Instantiates XPathQueryBuilder from the existing xPathQuery.
XPathQueryBuilder	idValue(String idValue)	Defines the id attribute value to search
XPathQueryBuilder	notChildOf(DSSElement notChildOf)	Defines that the looking element shall not be a parent of notParentOf element

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XPathQueryBuilder

protected XPathQueryBuilder()

Empty constructor instantiating object with empty configuration

Method Details

fromCurrentPosition

public static XPathQueryBuilder fromCurrentPosition()

Instantiates an XPath from the current position

Returns:

XPathQueryBuilder

fromCurrentPosition

public XPathQueryBuilder fromCurrentPosition(boolean fromCurrentPosition)

Defines if to start XPath from the current position

Parameters:

fromCurrentPosition - if to start XPath from the current position

Returns:

this XPathQueryBuilder

all

public static XPathQueryBuilder all()

Instantiates an XPath to search all element occurrences

Returns:

XPathQueryBuilder

all

public XPathQueryBuilder all(boolean all)

Defines if to search all element occurrences

Parameters:

all - if to search all element occurrences

Returns:

this XPathQueryBuilder

allFromCurrentPosition

public static XPathQueryBuilder allFromCurrentPosition()

Instantiates an XPath to search all element occurrences from the current position

Returns:

XPathQueryBuilder

fromXPathQuery

public static XPathQueryBuilder fromXPathQuery(XPathQuery xPathQuery)

Instantiates XPathQueryBuilder from the existing xPathQuery. This method will create a new XPathQuery, and when any setters are used, they will override the existing values.

Parameters:

xPathQuery - XPathQuery to instantiate a builder from

Returns:

XPathQueryBuilder

element

public XPathQueryBuilder element(DSSElement element)

Defines the element to search

Parameters:

element - DSSElement to search

Returns:

this XPathQueryBuilder

elements

public XPathQueryBuilder elements(DSSElement... elements)

Defines the element path to search

Parameters:

elements - a DSSElements chain to search

Returns:

this XPathQueryBuilder

notChildOf

public XPathQueryBuilder notChildOf(DSSElement notChildOf)

Defines that the looking element shall not be a parent of notParentOf element

Parameters:

notChildOf - DSSElement parent element that shall not be present

Returns:

this XPathQueryBuilder

attribute

public XPathQueryBuilder attribute(DSSAttribute attribute)

Defines the attribute to search. When used, the attribute is to searched on the child of the last defined element.

Parameters:

attribute - DSSAttribute

Returns:

this XPathQueryBuilder

attribute

public XPathQueryBuilder attribute(DSSAttribute attribute,
 String attributeValue)

Defines the attribute with the value to search. When used, the attribute is to searched on the child of the last defined element.

Parameters:

attribute - DSSAttribute

attributeValue - String

Returns:

this XPathQueryBuilder

idValue

public XPathQueryBuilder idValue(String idValue)

Defines the id attribute value to search

Parameters:

idValue - String

Returns:

this XPathQueryBuilder

build

public XPathQuery build()

Builds the XPath expression query

Returns:

XPathQuery