com.xmlmind.xml.xpointer

Class XPointerXPointer

java.lang.Object

com.xmlmind.xml.xpointer.XPointerXPointer

All Implemented Interfaces:

SimpleXPointer

public final class XPointerXPointer
extends Object
implements SimpleXPointer

A simple xpointer conforming to the xpointer() scheme.

See Also:

XPointerScheme

Field Summary

Fields

Modifier and Type	Field and Description
NodeSetExpr	nodeSetExpr The XPath expression which is used to implement the node search.
String	stringForm The string form of nodeSetExpr.

Constructor Summary

Constructors

Constructor and Description
XPointerXPointer(NodeSetExpr nodeSetExpr) Equivalent to this(nodeSetExpr, null).
XPointerXPointer(NodeSetExpr nodeSetExpr, String stringForm) Constructs an xpointer having specified XPath expression in compiled and in string forms.

Method Summary

Modifier and Type	Method and Description
Node[]	findNodes(Document doc, Object context) Searches specified document and returns the range of nodes selected by this xpointer.
String	toString() Returns the string representation of this xpointer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

nodeSetExpr

public final NodeSetExpr nodeSetExpr

The XPath expression which is used to implement the node search.

stringForm

public final String stringForm

The string form of nodeSetExpr. May be null (if it's unavailable).

Constructor Detail

XPointerXPointer

public XPointerXPointer(NodeSetExpr nodeSetExpr)

Equivalent to this(nodeSetExpr, null).

XPointerXPointer

public XPointerXPointer(NodeSetExpr nodeSetExpr,
                        String stringForm)

Constructs an xpointer having specified XPath expression in compiled and in string forms.

See Also:

nodeSetExpr, stringForm

Method Detail

toString

public String toString()

Returns the string representation of this xpointer. This representation can be parsed if stringForm is not null.

Overrides:

toString in class Object

findNodes

public Node[] findNodes(Document doc,
                        Object context)
                 throws XPointerException

Description copied from interface: SimpleXPointer

Searches specified document and returns the range of nodes selected by this xpointer.

Specified by:

findNodes in interface SimpleXPointer

Parameters:

doc - document to be searched

context - a context object (for example, cached data) which is specific to the scheme of this xpointer. May be null

An implementation cannot count on a context to be available.

Returns:

found range of sibling nodes or null

Throws:

XPointerException - if an error occurs during the search or if no nodes selected by this xpointer are found

Note that an implementation may choose to return null rather than raise an exception.