Package org.docx4j.jaxb.generic

Class NamespacePrefixMapperRelationshipsPart

java.lang.Object
org.docx4j.jaxb.generic.NamespacePrefixMapperRelationshipsPart
All Implemented Interfaces:
McIgnorableNamespaceDeclarator, NamespacePrefixMapperInterface
public class NamespacePrefixMapperRelationshipsPart extends Object implements NamespacePrefixMapperInterface, McIgnorableNamespaceDeclarator
NamespacePrefixMapper, which could be used by MOXy (relying on org.eclipse.persistence.internal.oxm.record.namespaces.NamespacePrefixMapperWrapper) But instead (to avoid additional reflection), we use org.docx4j.jaxb.moxy.NamespacePrefixMapper So this class isn't currently used.
Author:
jharrop

  • Constructor Details

    • NamespacePrefixMapperRelationshipsPart

      public NamespacePrefixMapperRelationshipsPart()

  • Method Details

    • 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 one is used *only* when we marshal the relationships part. This method is intended to be overrided by a derived class.
      Specified by:
      getPreferredPrefix in interface NamespacePrefixMapperInterface
      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.

    • getPreferredPrefixStatic

      protected static String getPreferredPrefixStatic(String namespaceUri, String suggestion, boolean requirePrefix)

    • getPreDeclaredNamespaceUris

      public String[] getPreDeclaredNamespaceUris()
      Description copied from interface: NamespacePrefixMapperInterface
      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>
   &lt;ns1:child xmlns:ns1="urn:foo"> ... &lt;/ns1:child>
   &lt;ns2:child xmlns:ns2="urn:foo"> ... &lt;/ns2:child>
   &lt;ns3:child xmlns:ns3="urn:foo"> ... &lt;/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: 

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

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

      Specified by:
      getPreDeclaredNamespaceUris in interface NamespacePrefixMapperInterface
      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 "".

    • getPreDeclaredNamespaceUris2

      public String[] getPreDeclaredNamespaceUris2()
      Description copied from interface: NamespacePrefixMapperInterface
      Similar to NamespacePrefixMapperInterface.getPreDeclaredNamespaceUris() but allows the (prefix,nsUri) pairs to be returned.

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

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

      Specified by:
      getPreDeclaredNamespaceUris2 in interface NamespacePrefixMapperInterface
      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.

    • getContextualNamespaceDecls

      public String[] getContextualNamespaceDecls()
      Description copied from interface: NamespacePrefixMapperInterface
      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: 

      
   &lt;foo:abc xmlns:foo="abc">
     &lt;foo:abc xmlns:foo="def">
       &lt;foo:abc xmlns:foo="abc">
         ... JAXB marshalling into here.
       &lt;/foo:abc>
     &lt;/foo:abc>
   &lt;/foo:abc>
      Specified by:
      getContextualNamespaceDecls in interface NamespacePrefixMapperInterface
      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.