Top Description Fields Methods
org.apache.xerces.xpointer

public Interface XPointerProcessor

Known Direct Implementers
org.apache.xerces.xpointer.XPointerHandler
Imports
org.apache.xerces.xni.Augmentations, .QName, .XMLAttributes, .XNIException

The XPointerProcessor is responsible for parsing an XPointer expression and and providing scheme specific resolution of the document fragment pointed to be the pointer.

Version
$Id: XPointerProcessor.java 603808 2007-12-13 03:44:48Z mrglavas $

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if the xpointer expression matches a node/fragment in the resource else returns false.
isFragmentResolved
()

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.

public boolean

Returns:

True if the xpointer expression matches a fragment in the resource else returns false.
isXPointerResolved
()

Returns true if the XPointer expression resolves any subresource of the input resource.

public void
parseXPointer(String
A String representing the xpointer expression.
xpointer
)

Parses an XPointer expression.

public boolean

Returns:

true if the element was resolved by the xpointer
resolveXPointer
(QName
- The name of the element.
element
,
XMLAttributes
- The element attributes.
attributes
,
Augmentations
- Additional information that may include infoset augmentations
augs
,
int
- An integer indicating 0 - The start of an element 1 - The end of an element 2 - An empty element call
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 Detail

EVENT_ELEMENT_EMPTYback to summary
public static final int EVENT_ELEMENT_EMPTY
EVENT_ELEMENT_ENDback to summary
public static final int EVENT_ELEMENT_END
EVENT_ELEMENT_STARTback to summary
public static final int EVENT_ELEMENT_START

Method Detail

isFragmentResolvedback to summary
public boolean isFragmentResolved() throws XNIException

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.

Returns:boolean

True if the xpointer expression matches a node/fragment in the resource else returns false.

Exceptions
XNIException:
Thrown to signal an error
isXPointerResolvedback to summary
public boolean isXPointerResolved() throws XNIException

Returns true if the XPointer expression resolves any subresource of the input resource.

Returns:boolean

True if the xpointer expression matches a fragment in the resource else returns false.

Exceptions
XNIException:
Thrown to signal an error
parseXPointerback to summary
public void parseXPointer(String xpointer) throws XNIException

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:String

A String representing the xpointer expression.

Exceptions
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.
resolveXPointerback to summary
public boolean resolveXPointer(QName element, XMLAttributes attributes, Augmentations augs, int event) throws 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:QName

- The name of the element.

attributes:XMLAttributes

- The element attributes.

augs:Augmentations

- Additional information that may include infoset augmentations

event:int

- An integer indicating 0 - The start of an element 1 - The end of an element 2 - An empty element call

Returns:boolean

true if the element was resolved by the xpointer

Exceptions
XNIException:
Thrown to signal an error