Package com.sun.xml.bind.marshaller

Class NamespacePrefixMapper

java.lang.Object

com.sun.xml.bind.marshaller.NamespacePrefixMapper

public abstract class NamespacePrefixMapper
extends java.lang.Object

Implemented by the user application to determine URI -> prefix mapping. This is considered as an interface, though it's implemented as an abstract class to make it easy to add new methods in a future.

Author:

Kohsuke Kawaguchi ([email protected])

Constructor Summary

Constructors

Constructor	Description
NamespacePrefixMapper()

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getContextualNamespaceDecls()	Returns a list of (prefix,namespace URI) pairs that represents namespace bindings available on ancestor elements (that need not be repeated by the JAXB RI.)
java.lang.String[]	getPreDeclaredNamespaceUris()	Returns a list of namespace URIs that should be declared at the root element.
java.lang.String[]	getPreDeclaredNamespaceUris2()	Similar to getPreDeclaredNamespaceUris() but allows the (prefix,nsUri) pairs to be returned.
abstract java.lang.String	getPreferredPrefix(java.lang.String namespaceUri, java.lang.String suggestion, boolean requirePrefix)	Returns a preferred prefix for the given namespace URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespacePrefixMapper

public NamespacePrefixMapper()

Method Detail

getPreferredPrefix

public abstract java.lang.String getPreferredPrefix(java.lang.String namespaceUri,
                                                    java.lang.String suggestion,
                                                    boolean requirePrefix)

Returns a preferred prefix for the given namespace URI. This method is intended to be overrided by a derived class.

As noted in the return value portion of the javadoc, there are several cases where the preference cannot be honored. Specifically, as of JAXB RI 2.0 and onward:

1. If the prefix returned is already in use as one of the in-scope namespace bindings. This is partly necessary for correctness (so that we don't unexpectedly change the meaning of QNames bound to String), partly to simplify the marshaller.
2. If the prefix returned is "" yet the current JAXBContext includes classes that use the empty namespace URI. This allows the JAXB RI to reserve the "" prefix for the empty namespace URI, which is the only possible prefix for the URI. This restriction is also to simplify the marshaller.

Parameters:

namespaceUri - The namespace URI for which the prefix needs to be found. Never be null. "" is used to denote the default namespace.

suggestion - When the content tree has a suggestion for the prefix to the given namespaceUri, that suggestion is passed as a parameter. Typicall this value comes from the QName.getPrefix to show the preference of the content tree. This parameter may be null, and this parameter may represent an already occupied prefix.

requirePrefix - If this method is expected to return non-empty prefix. When this flag is true, it means that the given namespace URI cannot be set as the default namespace.

Returns:

null if there's no prefered prefix for the namespace URI. In this case, the system will generate a prefix for you. Otherwise the system will try to use the returned prefix, but generally there's no guarantee if the prefix will be actually used or not. return "" to map this namespace URI to the default namespace. Again, there's no guarantee that this preference will be honored. If this method returns "" when requirePrefix=true, the return value will be ignored and the system will generate one.

Since:

JAXB 1.0.1

getPreDeclaredNamespaceUris

public java.lang.String[] getPreDeclaredNamespaceUris()

Returns a list of namespace URIs that should be declared at the root element.

By default, the JAXB RI 1.0.x produces namespace declarations only when they are necessary, only at where they are used. Because of this lack of look-ahead, sometimes the marshaller produces a lot of namespace declarations that look redundant to human eyes. For example,

 <?xml version="1.0"?>
 <root>
   <ns1:child xmlns:ns1="urn:foo"> ... </ns1:child>
   <ns2:child xmlns:ns2="urn:foo"> ... </ns2:child>
   <ns3:child xmlns:ns3="urn:foo"> ... </ns3:child>
   ...
 </root>
 

The JAXB RI 2.x mostly doesn't exhibit this behavior any more, as it declares all statically known namespace URIs (those URIs that are used as element/attribute names in JAXB annotations), but it may still declare additional namespaces in the middle of a document, for example when (i) a QName as an attribute/element value requires a new namespace URI, or (ii) DOM nodes as a portion of an object tree requires a new namespace URI.

If you know in advance that you are going to use a certain set of namespace URIs, you can override this method and have the marshaller declare those namespace URIs at the root element.

For example, by returning new String[]{"urn:foo"}, the marshaller will produce:

 <?xml version="1.0"?>
 <root xmlns:ns1="urn:foo">
   <ns1:child> ... </ns1:child>
   <ns1:child> ... </ns1:child>
   <ns1:child> ... </ns1:child>
   ...
 </root>
 

To control prefixes assigned to those namespace URIs, use the getPreferredPrefix(String, String, boolean) method.

Returns:

A list of namespace URIs as an array of Strings. This method can return a length-zero array but not null. None of the array component can be null. To represent the empty namespace, use the empty string "".

Since:

JAXB RI 1.0.2

getPreDeclaredNamespaceUris2

public java.lang.String[] getPreDeclaredNamespaceUris2()

Similar to getPreDeclaredNamespaceUris() but allows the (prefix,nsUri) pairs to be returned.

With getPreDeclaredNamespaceUris(), applications who wish to control the prefixes as well as the namespaces needed to implement both getPreDeclaredNamespaceUris() and getPreferredPrefix(String, String, boolean).

This version eliminates the needs by returning an array of pairs.

Returns:

always return a non-null (but possibly empty) array. The array stores data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent the empty namespace URI and the default prefix. Null is not allowed as a value in the array.

Since:

JAXB RI 2.0 beta

getContextualNamespaceDecls

public java.lang.String[] getContextualNamespaceDecls()

Returns a list of (prefix,namespace URI) pairs that represents namespace bindings available on ancestor elements (that need not be repeated by the JAXB RI.)

Sometimes JAXB is used to marshal an XML document, which will be used as a subtree of a bigger document. When this happens, it's nice for a JAXB marshaller to be able to use in-scope namespace bindings of the larger document and avoid declaring redundant namespace URIs.

This is automatically done when you are marshalling to XMLStreamWriter, XMLEventWriter, DOMResult, or Node, because those output format allows us to inspect what's currently available as in-scope namespace binding. However, with other output format, such as OutputStream, the JAXB RI cannot do this automatically. That's when this method comes into play.

Namespace bindings returned by this method will be used by the JAXB RI, but will not be re-declared. They are assumed to be available when you insert this subtree into a bigger document.

It is NOT OK to return the same binding, or give the receiver a conflicting binding information. It's a responsibility of the caller to make sure that this doesn't happen even if the ancestor elements look like:

   <foo:abc xmlns:foo="abc">
     <foo:abc xmlns:foo="def">
       <foo:abc xmlns:foo="abc">
         ... JAXB marshalling into here.
       </foo:abc>
     </foo:abc>
   </foo:abc>
 

Returns:

always return a non-null (but possibly empty) array. The array stores data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent the empty namespace URI and the default prefix. Null is not allowed as a value in the array.

Since:

JAXB RI 2.0 beta