com.xmlmind.xml.xpointer

Class ElementXPointer

java.lang.Object

com.xmlmind.xml.xpointer.ElementXPointer

All Implemented Interfaces:

SimpleXPointer

public final class ElementXPointer
extends Object
implements SimpleXPointer

A simple xpointer conforming to the element() scheme.

See Also:

ElementScheme

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElementXPointer.Context Context object which may be used to accelerate the node search.
static class	ElementXPointer.ContextImpl An implementation of ElementXPointer.Context.

Field Summary

Fields

Modifier and Type	Field and Description
int[]	descendant Location part of this xpointer if any; an empty array otherwise.
String	id ID part of this xpointer if any; null otherwise.

Constructor Summary

Constructors

Constructor and Description
ElementXPointer(String id) Constructs an XPointer pointing to element with specified ID.
ElementXPointer(String id, int[] descendant) Constructs an XPointer pointing to specified descendant of element with specified ID.

Method Summary

Modifier and Type	Method and Description
Element	findElement(Document doc) Find in specified document the element selected by this xpointer.
Element	findElement(Document doc, ElementXPointer.Context context) Find in specified document the element selected by this xpointer.
Node[]	findNodes(Document doc, Object context) Searches specified document and returns the range of nodes selected by this xpointer.
boolean	isElementID() Returns true if this XPointer is element(ID); returns false otherwise.
boolean	isRootElement() Returns true if this XPointer is element(/1); returns false otherwise.
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

id

public final String id

ID part of this xpointer if any; null otherwise.

descendant

public final int[] descendant

Location part of this xpointer if any; an empty array otherwise.

Constructor Detail

ElementXPointer

public ElementXPointer(String id)

Constructs an XPointer pointing to element with specified ID. Specified ID may not be null.

ElementXPointer

public ElementXPointer(String id,
                       int[] descendant)

Constructs an XPointer pointing to specified descendant of element with specified ID. Both ID and descendant location may not be null.

Example 1: for "#element(foo/1/2)", pass id=foo and descendant=[1,2].

Example 2: for "#element(/1/2)", pass id=null and descendant=[1,2].

Example 3: for "#foo", pass id=foo and descendant=null.

Method Detail

isRootElement

public boolean isRootElement()

Returns true if this XPointer is element(/1); returns false otherwise.

isElementID

public boolean isElementID()

Returns true if this XPointer is element(ID); returns false otherwise.

toString

public String toString()

Returns the string representation of this XPointer. This representation can be parsed.

Overrides:

toString in class Object

findElement

public Element findElement(Document doc)

Find in specified document the element selected by this xpointer.

Parameters:

doc - document to be searched

Returns:

found element or null

findElement

public Element findElement(Document doc,
                           ElementXPointer.Context context)

Find in specified document the element selected by this xpointer.

Parameters:

doc - document to be searched

context - context object used to accelerate the search. May not be null.

Returns:

found element or null

findNodes

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

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