org.apache.xerces.xpointer

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

Version: $Id: XPointerPart.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
StringgetSchemeData()
Returns a String containing the scheme data of the PointerPart.
StringgetSchemeName()
Returns a String containing the scheme name of the PointerPart or the name of the ShortHand Pointer.
booleanisChildFragmentResolved()
Returns true if the XPointer expression resolves to a non-element child of the current resource fragment.
booleanisFragmentResolved()
Returns true if the XPointer expression resolves to a resource fragment specified as input else returns false.
voidparseXPointer(String part)
Provides scheme specific parsing of a XPointer expression i.e. the PointerPart or ShortHandPointer.
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.
voidsetSchemeData(String schemeData)
Sets the scheme data of the PointerPart.
voidsetSchemeName(String schemeName)
Sets the scheme name of the PointerPart or the ShortHand Pointer name.

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

getSchemeData

public String getSchemeData()
Returns a String containing the scheme data of the PointerPart.

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

getSchemeName

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

isChildFragmentResolved

public 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

isFragmentResolved

public 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

parseXPointer

public void parseXPointer(String part)
Provides scheme specific parsing of a XPointer expression i.e. the PointerPart or ShortHandPointer.

Parameters: xpointer A String representing the PointerPart or ShortHandPointer.

Throws: XNIException Thrown if the PointerPart string does not conform to the syntax defined by 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

Throws: XNIException Thrown to signal an error

setSchemeData

public void setSchemeData(String schemeData)
Sets the scheme data of the PointerPart.

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

setSchemeName

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

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.