Top Description Methods
org.jdom2.xpath

public Interface XPathDiagnostic<T>

Known Direct Implementers
org.jdom2.xpath.util.XPathDiagnosticImpl
Type Parameters
<T>
The generic type of the results retruend by the expression.
Imports
java.util.List
Class representing the results of an XPath query allowing JDOM users to trace whether an item returned from an XPath query is subsequently filtered by the coercion filter attached to the XPathExpression;
Author
Rolf Lear

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

The context object against which the XPath query was evaluated.
getContext()

public List<Object>

Returns:

those results which were returned by the XPath query but were filtered out by the JDOM Filter.
getFilteredResults()

Returns the XPath results which are not returned by the regular evaluate process.

public List<Object>

Returns:

those results which were returned by the XPath query before any filtering.
getRawResults()

Returns the XPath results before any were filtered.

public List<T>

Returns:

the regular evaluated results.
getResult()

Returns the results as they would be returned by the regular evaluate process (read-only).

public XPathExpression<T>

Returns:

the XPathExpression instance that generated this diagnostic.
getXPathExpression()

public boolean

Returns:

true if the evaluation was a first-only evaluation.
isFirstOnly()

Indicate whether the query was evaluated as a first-only evaluation.

Method Detail

getContextback to summary
public Object getContext()
Returns:Object

The context object against which the XPath query was evaluated.

getFilteredResultsback to summary
public List<Object> getFilteredResults()

Returns the XPath results which are not returned by the regular evaluate process.

Returns:List<Object>

those results which were returned by the XPath query but were filtered out by the JDOM Filter.

getRawResultsback to summary
public List<Object> getRawResults()

Returns the XPath results before any were filtered.

Returns:List<Object>

those results which were returned by the XPath query before any filtering.

getResultback to summary
public List<T> getResult()

Returns the results as they would be returned by the regular evaluate process (read-only).

Returns:List<T>

the regular evaluated results.

getXPathExpressionback to summary
public XPathExpression<T> getXPathExpression()
Returns:XPathExpression<T>

the XPathExpression instance that generated this diagnostic.

isFirstOnlyback to summary
public boolean isFirstOnly()

Indicate whether the query was evaluated as a first-only evaluation. XPath libraries are allowed to stop processing the results after the first result is retrieved if first-only processing is set.

Returns:boolean

true if the evaluation was a first-only evaluation.