Package org.jdom.xpath
Interface XPathDiagnostic<T>
-
- Type Parameters:
T
- The generic type of the results retruend by the expression.
- All Known Implementing Classes:
XPathDiagnosticImpl
public interface XPathDiagnostic<T>
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 theXPathExpression
;
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
getContext()
List<Object>
getFilteredResults()
Returns the XPath results which are not returned by the regular evaluate process.List<Object>
getRawResults()
Returns the XPath results before any were filtered.List<T>
getResult()
Returns the results as they would be returned by the regular evaluate process (read-only).XPathExpression<T>
getXPathExpression()
boolean
isFirstOnly()
Indicate whether the query was evaluated as a first-only evaluation.
-
-
-
Method Detail
-
getContext
Object getContext()
- Returns:
- The context object against which the XPath query was evaluated.
-
getXPathExpression
XPathExpression<T> getXPathExpression()
- Returns:
- the
XPathExpression
instance that generated this diagnostic.
-
getResult
List<T> getResult()
Returns the results as they would be returned by the regular evaluate process (read-only).- Returns:
- the regular evaluated results.
-
getFilteredResults
List<Object> getFilteredResults()
Returns the XPath results which are not returned by the regular evaluate process.- Returns:
- those results which were returned by the XPath query but were filtered out by the JDOM Filter.
-
getRawResults
List<Object> getRawResults()
Returns the XPath results before any were filtered.- Returns:
- those results which were returned by the XPath query before any filtering.
-
isFirstOnly
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:
- true if the evaluation was a first-only evaluation.
-
-