public interface

XPointerPart

org.apache.xerces.xpointer.XPointerPart

Class Overview

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

@xerces.internal

Summary

Constants
int EVENT_ELEMENT_EMPTY
int EVENT_ELEMENT_END
int EVENT_ELEMENT_START
Public Methods
abstract String getSchemeData()
Returns a String containing the scheme data of the PointerPart.
abstract String getSchemeName()
Returns a String containing the scheme name of the PointerPart or the name of the ShortHand Pointer.
abstract boolean isChildFragmentResolved()
Returns true if the XPointer expression resolves to a non-element child of the current resource fragment.
abstract boolean isFragmentResolved()
Returns true if the XPointer expression resolves to a resource fragment specified as input else returns false.
abstract void parseXPointer(String part)
Provides scheme specific parsing of a XPointer expression i.e.
abstract boolean resolveXPointer(QName element, XMLAttributes attributes, 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.
abstract void setSchemeData(String schemeData)
Sets the scheme data of the PointerPart.
abstract void setSchemeName(String schemeName)
Sets the scheme name of the PointerPart or the ShortHand Pointer name.

Constants

public static final int EVENT_ELEMENT_EMPTY

Constant Value: 2 (0x00000002)

public static final int EVENT_ELEMENT_END

Constant Value: 1 (0x00000001)

public static final int EVENT_ELEMENT_START

Constant Value: 0 (0x00000000)

Public Methods

public abstract String getSchemeData ()

Returns a String containing the scheme data of the PointerPart.

Returns
  • A String containing the scheme data of the PointerPart.

public abstract String getSchemeName ()

Returns a String containing the scheme name of the PointerPart or the name of the ShortHand Pointer.

Returns
  • A String containing the scheme name of the PointerPart.

public abstract boolean isChildFragmentResolved ()

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

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

public abstract boolean isFragmentResolved ()

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

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

public abstract void parseXPointer (String part)

Provides scheme specific parsing of a XPointer expression i.e. the PointerPart or ShortHandPointer.

Parameters
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 abstract boolean resolveXPointer (QName element, XMLAttributes attributes, 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.

Parameters
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations
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 abstract void setSchemeData (String schemeData)

Sets the scheme data of the PointerPart.

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

public abstract void setSchemeName (String schemeName)

Sets the scheme name of the PointerPart or the ShortHand Pointer name.

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