FileDocCategorySizeDatePackage
XPointerPart.javaAPI DocApache Xerces 3.0.14723Fri Sep 14 20:33:52 BST 2007org.apache.xerces.xpointer

XPointerPart

public interface XPointerPart

Used for scheme specific parsing and evaluation of an XPointer expression. This interface applies to both ShortHand and SchemeBased XPointer expressions.

xerces.internal
version
$Id: XPointerPart.java 449487 2006-09-24 21:11:28Z mrglavas $

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 java.lang.StringgetSchemeData()
Returns a String containing the scheme data of the PointerPart.

return
A String containing the scheme data of the PointerPart.

public java.lang.StringgetSchemeName()
Returns a String containing the scheme name of the PointerPart or the name of the ShortHand Pointer.

return
A String containing the scheme name of the PointerPart.

public booleanisChildFragmentResolved()
Returns true if the XPointer expression resolves to a non-element child of the current resource fragment.

return
True if the XPointer expression resolves to a non-element child of the current resource fragment.
throws
XNIException Thrown to signal an error

public booleanisFragmentResolved()
Returns true if the XPointer expression resolves to a resource fragment specified as input else returns false.

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 part)
Provides scheme specific parsing of a XPointer expression i.e. the PointerPart or ShortHandPointer.

param
part A String representing the PointerPart or ShortHandPointer.
throws
XNIException Thrown if the PointerPart string does not conform to the syntax defined by its scheme.

public booleanresolveXPointer(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.

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
throws
XNIException Thrown to signal an error

public voidsetSchemeData(java.lang.String schemeData)
Sets the scheme data of the PointerPart.

param
schemeData A String containing the scheme data of the PointerPart.

public voidsetSchemeName(java.lang.String schemeName)
Sets the scheme name of the PointerPart or the ShortHand Pointer name.

param
schemeName A String containing the scheme name of the PointerPart.