org.openprovenance.prov.model

Interface NamespacePrefixMapper

public interface NamespacePrefixMapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOK_NS
static String	BOOK_PREFIX
static String	PRINTER_NS
static String	PROV_NS
static String	PROV_PREFIX
static String	RDF_NS
static String	RDF_PREFIX
static String	RDFS_NS
static String	RDFS_PREFIX
static String	TOOLBOX_NS
static String	XML_NS
static String	XSD_HASH_NS
static String	XSD_NS
static String	XSD_PREFIX
static String	XSI_NS

Method Summary

Methods

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.

Field Detail

PROV_NS

static final String PROV_NS

See Also:

Constant Field Values

XSI_NS

static final String XSI_NS

See Also:

Constant Field Values

XSD_NS

static final String XSD_NS

See Also:

Constant Field Values

XSD_HASH_NS

static final String XSD_HASH_NS

See Also:

Constant Field Values

PRINTER_NS

static final String PRINTER_NS

See Also:

Constant Field Values

XML_NS

static final String XML_NS

See Also:

Constant Field Values

PROV_PREFIX

static final String PROV_PREFIX

See Also:

Constant Field Values

XSD_PREFIX

static final String XSD_PREFIX

See Also:

Constant Field Values

RDF_NS

static final String RDF_NS

See Also:

Constant Field Values

RDF_PREFIX

static final String RDF_PREFIX

See Also:

Constant Field Values

RDFS_NS

static final String RDFS_NS

See Also:

Constant Field Values

RDFS_PREFIX

static final String RDFS_PREFIX

See Also:

Constant Field Values

BOOK_PREFIX

static final String BOOK_PREFIX

See Also:

Constant Field Values

BOOK_NS

static final String BOOK_NS

See Also:

Constant Field Values

TOOLBOX_NS

static final String TOOLBOX_NS

See Also:

Constant Field Values

Method Detail

getPreferredPrefix

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.

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

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/openprovenance/prov/model/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="strong">Returns:</span></dt><dd>A list of namespace URIs as an array of <a href="http://docs.oracle.com/javase/7/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="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="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><a href="../../../../org/openprovenance/prov/model/NamespaceGatherer.html" title="class in org.openprovenance.prov.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/openprovenance/prov/model/ObjectFactory.html" title="interface in org.openprovenance.prov.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/openprovenance/prov/model/NamespacePrefixMapper.html" target="_top">Frames</a></li>
<li><a href="NamespacePrefixMapper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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; 2013. All Rights Reserved.</small></p>
</body>
</html>