Package org.apache.xerces.xpointer
Interface XPointerProcessor
- All Known Implementing Classes:
XPointerHandler
public interface XPointerProcessor
The XPointerProcessor is responsible for parsing an XPointer expression and and providing scheme specific resolution of the document fragment pointed to be the pointer.
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Version:
- $Id: XPointerProcessor.java 603808 2007-12-13 03:44:48Z mrglavas $
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the XPointer expression resolves to the current resource fragment or Node which is part of the input resource being streamed else returns false.boolean
Returns true if the XPointer expression resolves any subresource of the input resource.void
parseXPointer
(String xpointer) Parses an XPointer expression.boolean
resolveXPointer
(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs, int event) Evaluates an XML resource with respect to an XPointer expressions by checking if it's element and attributes parameters match the criteria specified in the xpointer expression.
-
Field Details
-
EVENT_ELEMENT_START
static final int EVENT_ELEMENT_START- See Also:
-
EVENT_ELEMENT_END
static final int EVENT_ELEMENT_END- See Also:
-
EVENT_ELEMENT_EMPTY
static final int EVENT_ELEMENT_EMPTY- See Also:
-
-
Method Details
-
parseXPointer
Parses an XPointer expression. It performs scheme specific processing depending on the pointer parts and sets up a Vector of XPointerParts in the order (left-to-right) they appear in the XPointer expression.- Parameters:
xpointer
- A String representing the xpointer expression.- Throws:
org.apache.xerces.xni.XNIException
- Thrown if the xpointer string does not conform to the XPointer Framework syntax or the syntax of the pointer part does not conform to its definition for its scheme.
-
resolveXPointer
boolean resolveXPointer(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs, int event) throws org.apache.xerces.xni.XNIException Evaluates an XML resource with respect to an XPointer expressions by checking if it's element and attributes parameters match the criteria specified in the xpointer expression.- Parameters:
element
- - The name of the element.attributes
- - The element attributes.augs
- - Additional information that may include infoset augmentationsevent
- - An integer indicating 0 - The start of an element 1 - The end of an element 2 - An empty element call- Returns:
- true if the element was resolved by the xpointer
- Throws:
org.apache.xerces.xni.XNIException
- Thrown to signal an error
-
isFragmentResolved
boolean isFragmentResolved() throws org.apache.xerces.xni.XNIExceptionReturns true if the XPointer expression resolves to the current resource fragment or Node which is part of the input resource being streamed else returns false.- Returns:
- True if the xpointer expression matches a node/fragment in the resource else returns false.
- Throws:
org.apache.xerces.xni.XNIException
- Thrown to signal an error
-
isXPointerResolved
boolean isXPointerResolved() throws org.apache.xerces.xni.XNIExceptionReturns true if the XPointer expression resolves any subresource of the input resource.- Returns:
- True if the xpointer expression matches a fragment in the resource else returns false.
- Throws:
org.apache.xerces.xni.XNIException
- Thrown to signal an error
-