org.apache.axiom.util.namespace

Class ScopedNamespaceContext

java.lang.Object

org.apache.axiom.util.namespace.AbstractNamespaceContext

org.apache.axiom.util.namespace.ScopedNamespaceContext

All Implemented Interfaces:

javax.xml.namespace.NamespaceContext

public class ScopedNamespaceContext
extends AbstractNamespaceContext

NamespaceContext implementation that supports nested scopes. A scope is typically associated with a start tag / end tag pair. The implementation takes care of correctly handling masked namespace bindings. Masking occurs when the same prefix is bound to a different namespace URI in a nested scope.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	bindings The number of currently defined namespace bindings.
(package private) java.lang.String[]	prefixArray Array containing the prefixes for the namespace bindings.
private int[]	scopeIndexes Tracks the scopes defined for this namespace context.
private int	scopes The number of currently defined scopes.
(package private) java.lang.String[]	uriArray Array containing the URIs for the namespace bindings.

Constructor Summary

Constructors

Constructor and Description
ScopedNamespaceContext()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	doGetNamespaceURI(java.lang.String prefix) Get namespace URI bound to a prefix in the current scope.
protected java.lang.String	doGetPrefix(java.lang.String namespaceURI) Get prefix bound to namespace URI in the current scope.
protected java.util.Iterator	doGetPrefixes(java.lang.String namespaceURI) Get all prefixes bound to a namespace URI in the current scope.
void	endScope() End the current scope and restore the scope in which the current scope was nested.
void	setPrefix(java.lang.String prefix, java.lang.String namespaceURI) Define a prefix binding in the current scope.
void	startScope() Start a new scope.

Methods inherited from class org.apache.axiom.util.namespace.AbstractNamespaceContext

getNamespaceURI, getPrefix, getPrefixes

Methods inherited from class java.lang.Object

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

Field Detail

prefixArray

java.lang.String[] prefixArray

Array containing the prefixes for the namespace bindings.

uriArray

java.lang.String[] uriArray

Array containing the URIs for the namespace bindings.

bindings

int bindings

The number of currently defined namespace bindings.

scopeIndexes

private int[] scopeIndexes

Tracks the scopes defined for this namespace context. Each entry in the array identifies the first namespace binding defined in the corresponding scope and points to an entry in prefixArray/uriArray.

scopes

private int scopes

The number of currently defined scopes. This is the same as the depth of the current scope, where the depth of the root scope is 0.

Constructor Detail

ScopedNamespaceContext

public ScopedNamespaceContext()

Method Detail

setPrefix

public void setPrefix(java.lang.String prefix,
                      java.lang.String namespaceURI)

Define a prefix binding in the current scope. It will be visible in the current scope as well as each nested scope, unless the prefix is bound to a different namespace URI in that scope.

Parameters:

prefix - the prefix to bind or the empty string to set the default namespace; may not be null

namespaceURI - the corresponding namespace URI; may not be null

startScope

public void startScope()

Start a new scope. Since scopes are nested, this will not end the current scope.

endScope

public void endScope()

End the current scope and restore the scope in which the current scope was nested. This will remove all prefix bindings declared since the corresponding invocation of the startScope() method.

doGetNamespaceURI

protected java.lang.String doGetNamespaceURI(java.lang.String prefix)

Description copied from class: AbstractNamespaceContext

Get namespace URI bound to a prefix in the current scope. The contract of this method is the same as NamespaceContext.getNamespaceURI(String), except that the implementation is not required to handle the implicit namespace bindings.

Specified by:

doGetNamespaceURI in class AbstractNamespaceContext

Parameters:

prefix - prefix to look up

Returns:

namespace URI bound to prefix in the current scope

doGetPrefix

protected java.lang.String doGetPrefix(java.lang.String namespaceURI)

Description copied from class: AbstractNamespaceContext

Get prefix bound to namespace URI in the current scope. The contract of this method is the same as NamespaceContext.getPrefix(String), except that the implementation is not required to handle the implicit namespace bindings.

Specified by:

doGetPrefix in class AbstractNamespaceContext

Parameters:

namespaceURI - URI of namespace to lookup

Returns:

prefix bound to namespace URI in current context

doGetPrefixes

protected java.util.Iterator doGetPrefixes(java.lang.String namespaceURI)

Description copied from class: AbstractNamespaceContext

Get all prefixes bound to a namespace URI in the current scope. The contract of this method is the same as NamespaceContext.getPrefixes(String), except that the implementation is not required to handle the implicit namespace bindings.

Specified by:

doGetPrefixes in class AbstractNamespaceContext

Parameters:

namespaceURI - URI of namespace to lookup

Returns:

iterator for all prefixes bound to the namespace URI in the current scope