org.apache.xerces.xpointer

Interface 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.

Version: $Id: XPointerProcessor.java,v 1.1 2005/06/17 22:00:20 nddelima Exp $

UNKNOWN:

Field Summary
static intEVENT_ELEMENT_EMPTY
static intEVENT_ELEMENT_END
static intEVENT_ELEMENT_START
Method Summary
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.
booleanisXPointerResolved()
Returns true if the XPointer expression resolves any subresource of the input resource.
voidparseXPointer(String xpointer)
Parses an XPointer expression.
booleanresolveXPointer(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.

Field Detail

EVENT_ELEMENT_EMPTY

public static final int EVENT_ELEMENT_EMPTY

EVENT_ELEMENT_END

public static final int EVENT_ELEMENT_END

EVENT_ELEMENT_START

public static final int EVENT_ELEMENT_START

Method Detail

isFragmentResolved

public boolean 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.

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

Throws: XNIException Thrown to signal an error

isXPointerResolved

public boolean isXPointerResolved()
Returns 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: XNIException Thrown to signal an error

parseXPointer

public void parseXPointer(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.

Parameters: 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.

resolveXPointer

public 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

Returns: true if the element was resolved by the xpointer

Throws: XNIException Thrown to signal an error

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.