Class XPathQueryAttributeParameter

java.lang.Object

eu.europa.esig.dss.xml.common.xpath.item.AbstractXPathQueryItem

eu.europa.esig.dss.xml.common.xpath.item.AbstractXPathQueryParameter

eu.europa.esig.dss.xml.common.xpath.item.XPathQueryAttributeParameter

All Implemented Interfaces:

XPathQueryItem, XPathQueryParameter

Direct Known Subclasses:

XPathQueryIdentifierParameter

public class XPathQueryAttributeParameter
extends AbstractXPathQueryParameter

Allows extraction of an element by the given attribute

Constructor Summary

Constructors

Constructor	Description
XPathQueryAttributeParameter(DSSAttribute attribute, String attributeValue)	Constructor with an expected attribute value.
XPathQueryAttributeParameter(DSSAttribute attribute, String attributeValue, boolean ignoreCase)	Constructor with an expected attribute value with indication on whether case is to be ignored

Method Summary

Modifier and Type	Method	Description
DSSAttribute	getAttribute()	Gets the corresponding DSSAttribute
String	getAttributeValue()	Gets the expected attribute value
String	getQueryString()	Gets a string representation of the XPath expression chain item
boolean	isAttributeRelated()	Gets whether XPath query item is related to an Attribute node processing
boolean	isElementRelated()	Gets whether XPath query item is related to an Element node processing
protected boolean	process(Node node)	This method executes the XPath query item requirement, and returns whether the node satisfies the rule

Methods inherited from class AbstractXPathQueryParameter

addParameter, getParameters, matchNode

Modifier and Type	Method	Description
void	addParameter(XPathQueryParameter parameter)	Adds a parameter to the given XPath query item
List<XPathQueryParameter>	getParameters()	Gets parameters related to the given XPathQueryItem, if any
boolean	matchNode(Node node)	This method verifies whether the given node matches the XPathQueryItem

Methods inherited from class AbstractXPathQueryItem

getLocalName, isEmpty, nextItem, setNextItem, toString

Modifier and Type	Method	Description
protected String	getLocalName(Node node)	Gets the local name of a Node, without prefix, if any
boolean	isEmpty()	Gets whether the XPath query item is empty
XPathQueryItem	nextItem()	Gets the next XPath chain item, if any
XPathQueryItem	setNextItem(XPathQueryItem nextItem)	Sets the next eu.europa.esig.dss.xml.common.definition.xpath.item.XPathChainItem as part of the XPath expression
String	toString()

Methods inherited from class Object

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

Constructor Details

XPathQueryAttributeParameter

public XPathQueryAttributeParameter(DSSAttribute attribute,
 String attributeValue)

Constructor with an expected attribute value. When this constructor is used, the string case comparison is enforced.

Parameters:

attribute - DSSAttribute

attributeValue - String

XPathQueryAttributeParameter

public XPathQueryAttributeParameter(DSSAttribute attribute,
 String attributeValue,
 boolean ignoreCase)

Constructor with an expected attribute value with indication on whether case is to be ignored

Parameters:

attribute - DSSAttribute

attributeValue - String

ignoreCase - whether case comparison of the attribute name is to be ignored

Method Details

getAttribute

public DSSAttribute getAttribute()

Gets the corresponding DSSAttribute

Returns:

DSSAttribute

getAttributeValue

public String getAttributeValue()

Gets the expected attribute value

Returns:

String

process

protected boolean process(Node node)

Description copied from class: AbstractXPathQueryItem

This method executes the XPath query item requirement, and returns whether the node satisfies the rule

Specified by:

process in class AbstractXPathQueryItem

Parameters:

node - Node to verify

Returns:

TRUE if the condition matches, FALSE otherwise

isElementRelated

public boolean isElementRelated()

Description copied from interface: XPathQueryItem

Gets whether XPath query item is related to an Element node processing

Returns:

TRUE if XPath query item is related to an Element node processing, FALSE otherwise

isAttributeRelated

public boolean isAttributeRelated()

Description copied from interface: XPathQueryItem

Gets whether XPath query item is related to an Attribute node processing

Returns:

TRUE if XPath query item is related to an Attribute node processing, FALSE otherwise

getQueryString

public String getQueryString()

Description copied from interface: XPathQueryItem

Gets a string representation of the XPath expression chain item

Returns:

String