org.docx4j.jaxb.ri

Class NamespacePrefixMapper

java.lang.Object

com.sun.xml.bind.marshaller.NamespacePrefixMapper

org.docx4j.jaxb.ri.NamespacePrefixMapper

All Implemented Interfaces:

McIgnorableNamespaceDeclarator, NamespacePrefixMapperInterface

public class NamespacePrefixMapper
extends com.sun.xml.bind.marshaller.NamespacePrefixMapper
implements NamespacePrefixMapperInterface, McIgnorableNamespaceDeclarator

Constructor Summary

Constructors

Constructor and Description
NamespacePrefixMapper()

Method Summary

Modifier and Type	Method and Description
String[]	getPreDeclaredNamespaceUris() Returns a list of namespace URIs that should be declared at the root element.
String	getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) Returns a preferred prefix for the given namespace URI.
void	setMcIgnorable(String mcIgnorable)

Methods inherited from class com.sun.xml.bind.marshaller.NamespacePrefixMapper

getContextualNamespaceDecls, getPreDeclaredNamespaceUris2

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docx4j.jaxb.NamespacePrefixMapperInterface

getContextualNamespaceDecls, getPreDeclaredNamespaceUris2

Constructor Detail

NamespacePrefixMapper

public NamespacePrefixMapper()

Method Detail

setMcIgnorable

public void setMcIgnorable(String mcIgnorable)

Specified by:

setMcIgnorable in interface McIgnorableNamespaceDeclarator

getPreferredPrefix

public String getPreferredPrefix(String namespaceUri,
                                 String suggestion,
                                 boolean requirePrefix)

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

Specified by:

getPreferredPrefix in interface NamespacePrefixMapperInterface

Specified by:

getPreferredPrefix in class com.sun.xml.bind.marshaller.NamespacePrefixMapper

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. Typically this value comes from 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 preferred 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.

getPreDeclaredNamespaceUris

public String[] getPreDeclaredNamespaceUris()

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

By default, the JAXB RI 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>
 <xmp></pre>
 <p>
 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. 
 <p>
 For example, by returning <code>new String[]{"urn:foo"}</code>,
 the marshaller will produce:
 <pre><xmp>
 <?xml version="1.0"?>
 <root xmlns:ns1="urn:foo">
   <ns1:child> ... </ns1:child>
   <ns1:child> ... </ns1:child>
   <ns1:child> ... </ns1:child>
   ...
 </root>
 <xmp></pre>
 <p>
 To control prefixes assigned to those namespace URIs, use the
 <a href="../../../../org/docx4j/jaxb/ri/NamespacePrefixMapper.html#getPreferredPrefix-java.lang.String-java.lang.String-boolean-"><code>getPreferredPrefix(java.lang.String, java.lang.String, boolean)</code></a> method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://www.docx4java.org/docx4j-core/apidocs/org/docx4j/jaxb/NamespacePrefixMapperInterface.html?is-external=true#getPreDeclaredNamespaceUris--" title="class or interface in org.docx4j.jaxb">getPreDeclaredNamespaceUris</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.docx4java.org/docx4j-core/apidocs/org/docx4j/jaxb/NamespacePrefixMapperInterface.html?is-external=true" title="class or interface in org.docx4j.jaxb">NamespacePrefixMapperInterface</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getPreDeclaredNamespaceUris</code>&nbsp;in class&nbsp;<code>com.sun.xml.bind.marshaller.NamespacePrefixMapper</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of namespace URIs as an array of <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s.
      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 <code>""</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>JAXB RI 1.0.2</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/docx4j/jaxb/ri/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NamespacePrefixMapper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/docx4j/jaxb/ri/NamespacePrefixMapperRelationshipsPart.html" title="class in org.docx4j.jaxb.ri"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/docx4j/jaxb/ri/NamespacePrefixMapper.html" target="_top">Frames</a></li>
<li><a href="NamespacePrefixMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2021. All Rights Reserved.</small></p>
</body>
</html>