FileDocCategorySizeDatePackage
XPointerProcessor.javaAPI DocJava SE 6 API3865Tue Jun 10 00:22:54 BST 2008com.sun.org.apache.xerces.internal.xpointer

XPointerProcessor

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.

xerces.internal
version
$Id: XPointerProcessor.java,v 1.1.4.1 2005/09/08 05:25:46 sunithareddy Exp $

Fields Summary
public static final int
EVENT_ELEMENT_START
public static final int
EVENT_ELEMENT_END
public static final int
EVENT_ELEMENT_EMPTY
Constructors Summary
Methods Summary
public booleanisFragmentResolved()
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.

return
True if the xpointer expression matches a node/fragment in the resource else returns false.
throws
XNIException Thrown to signal an error

public booleanisXPointerResolved()
Returns true if the XPointer expression resolves any subresource of the input resource.

return
True if the xpointer expression matches a fragment in the resource else returns false.
throws
XNIException Thrown to signal an error

public voidparseXPointer(java.lang.String xpointer)
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.

param
xpointer A String representing the xpointer expression.
throws
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.

public booleanresolveXPointer(com.sun.org.apache.xerces.internal.xni.QName element, com.sun.org.apache.xerces.internal.xni.XMLAttributes attributes, com.sun.org.apache.xerces.internal.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.

param
element - The name of the element.
param
attributes - The element attributes.
param
augs - Additional information that may include infoset augmentations
param
event - An integer indicating 0 - The start of an element 1 - The end of an element 2 - An empty element call
return
true if the element was resolved by the xpointer
throws
XNIException Thrown to signal an error