org.openprovenance.prov.xml

Class NamespacePrefixMapper

java.lang.Object

com.sun.xml.bind.marshaller.NamespacePrefixMapper

org.openprovenance.prov.xml.NamespacePrefixMapper

All Implemented Interfaces:

NamespacePrefixMapper

public class NamespacePrefixMapper
extends com.sun.xml.bind.marshaller.NamespacePrefixMapper
implements NamespacePrefixMapper

Prefix definition for PROV serialisations.

Field Summary

Fields inherited from interface org.openprovenance.prov.model.NamespacePrefixMapper

BOOK_NS, BOOK_PREFIX, DOT_NS, DOT_PREFIX, PRINTER_NS, PROV_EXT_NS, PROV_NS, PROV_PREFIX, RDF_NS, RDF_PREFIX, RDFS_NS, RDFS_PREFIX, SHARED_PROV_TOOLBOX_PREFIX, SUMMARY_NS, SUMMARY_PREFIX, TOOLBOX_NS, TOOLBOX_PREFIX, XML_NS, XSD_NS, XSD_PREFIX, XSI_NS

Constructor Summary

Constructors

Constructor and Description
NamespacePrefixMapper(Namespace nss)

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.

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

Constructor Detail

NamespacePrefixMapper

public NamespacePrefixMapper(Namespace nss)

Method Detail

getPreferredPrefix

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

Description copied from interface: NamespacePrefixMapper

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 NamespacePrefixMapper

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()

Description copied from interface: NamespacePrefixMapper

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,

<xmp>
 <?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>

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:

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

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

Specified by:

getPreDeclaredNamespaceUris in interface NamespacePrefixMapper

Overrides:

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

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 "".