net.sf.practicalxml.xpath

Class NamespaceResolver

java.lang.Object

net.sf.practicalxml.xpath.NamespaceResolver

All Implemented Interfaces:

NamespaceContext

public class NamespaceResolver
extends Object
implements NamespaceContext

Maintains a bi-directional lookup table for mappings between namespace URIs and prefixes. Follows the "builder" pattern, in that the methods to add mappings may be chained: a resolver can be created and fully configured in a single expression.

Usage note: NamespaceContext allows multiple prefixes per URI, in keeping with the Namespace spec. This implementation supports that, but it's a bad idea to actually use this feature when writing an XPath. You'll be much happier if you limit yourself to a 1:1 mapping.

If you have a single namespace mapping, this implementation is overkill. Instead, use SimpleNamespaceResolver.

Constructor Summary

Constructors

Constructor and Description
NamespaceResolver()

Method Summary

Methods

Modifier and Type	Method and Description
NamespaceResolver	addNamespace(String prefix, String nsURI) Adds a namespace to this resolver.
protected NamespaceResolver	clone() Returns a deep clone of this object, that can then be independently manipulated.
boolean	equals(Object obj) Two instances are considered equal if they have the same mappings, including default namespace.
List<String>	getAllPrefixes() Returns a list of all prefixes known to this resolver, in alphabetical order.
String	getDefaultNamespace() Returns the default namespace, an empty string if one has not yet been set.
String	getNamespaceURI(String prefix) Returns the namespace URI bound to a given prefix, null if no URI is bound to the specified prefix.
String	getPrefix(String nsURI) Returns the first prefix in alphabetical order bound to this namespace URI, null if there is no binding for the namespace.
Iterator<String>	getPrefixes(String nsURI) Returns an iterator over all prefixes bound to this namespace URI, in alphabetical order, an empty iterator if there are no bindings.
int	hashCode()
NamespaceResolver	setDefaultNamespace(String nsURI) Sets the default namespace -- the namespace that will be returned when an empty string is passed to the resolver.
String	toString() Returns a string containing the the xmlns attribute specifications that would result from this resolver.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NamespaceResolver

public NamespaceResolver()

Method Detail

addNamespace

public NamespaceResolver addNamespace(String prefix,
                             String nsURI)

Adds a namespace to this resolver.

Returns:

The resolver instance, so that calls may be chained.

Throws:

IllegalArgumentException - if either prefix or nsURI is null.

setDefaultNamespace

public NamespaceResolver setDefaultNamespace(String nsURI)

Sets the default namespace -- the namespace that will be returned when an empty string is passed to the resolver.

Returns:

The resolver instance, so that calls may be chained.

Throws:

IllegalArgumentException - if nsURI is null.

getDefaultNamespace

public String getDefaultNamespace()

Returns the default namespace, an empty string if one has not yet been set.

getAllPrefixes

public List<String> getAllPrefixes()

Returns a list of all prefixes known to this resolver, in alphabetical order.

getNamespaceURI

public String getNamespaceURI(String prefix)

Returns the namespace URI bound to a given prefix, null if no URI is bound to the specified prefix. See interface doc for default bindings.

Specified by:

getNamespaceURI in interface NamespaceContext

getPrefix

public String getPrefix(String nsURI)

Returns the first prefix in alphabetical order bound to this namespace URI, null if there is no binding for the namespace. See interface doc for default bindings.

Specified by:

getPrefix in interface NamespaceContext

getPrefixes

public Iterator<String> getPrefixes(String nsURI)

Returns an iterator over all prefixes bound to this namespace URI, in alphabetical order, an empty iterator if there are no bindings. See interface doc for default bindings.

Specified by:

getPrefixes in interface NamespaceContext

equals

public final boolean equals(Object obj)

Two instances are considered equal if they have the same mappings, including default namespace.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string containing the the xmlns attribute specifications that would result from this resolver.

Overrides:

toString in class Object

clone

protected NamespaceResolver clone()

Returns a deep clone of this object, that can then be independently manipulated.

Overrides:

clone in class Object