| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>org.apache.sis.xml (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.xml package"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.xml (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.xml</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Provides methods for marshalling and unmarshalling SIS objects in XML. |
| The XML format is compliant with ISO 19115-3 specification for metadata, |
| and compliant with GML for referencing objects. |
| |
| <p>The main class in this package is <a href="XML.html" title="class in org.apache.sis.xml"><code>XML</code></a>, which provides |
| property keys that can be used for configuring (un)marshallers and convenience |
| static methods. For example the following code:</p> |
| |
| <blockquote><pre>XML.<b>marshal</b>(Citations.OGC, System.out);</pre></blockquote> |
| |
| will produce a string like below: |
| |
| <blockquote><pre><?xml version="1.0" encoding="UTF-8" standalone="yes"?> |
| <cit:CI_Citation xmlns:gmd="http://www.isotc211.org/2005/gmd" |
| xmlns:gco="http://www.isotc211.org/2005/gco"> |
| <cit:title> |
| <gco:CharacterString>Open Geospatial Consortium</gco:CharacterString> |
| </cit:title> |
| ... much more XML below this point ... |
| </cit:CI_Citation></pre></blockquote> |
| |
| <div class="section">Customizing the XML</div> |
| In order to parse and format ISO 19115-3 compliant documents, SIS needs its own |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/Marshaller.html?is-external=true" title="class or interface in javax.xml.bind" class="externalLink"><code>Marshaller</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/Unmarshaller.html?is-external=true" title="class or interface in javax.xml.bind" class="externalLink"><code>Unmarshaller</code></a> instances |
| (which are actually wrappers around standard instances). Those instances are created |
| and cached by <a href="MarshallerPool.html" title="class in org.apache.sis.xml"><code>MarshallerPool</code></a>, which is used internally by |
| the above-cited <code>XML</code> class. However developers can instantiate their own |
| <code>MarshallerPool</code> in order to get more control on the marshalling and unmarshalling |
| processes, including the namespace URLs and the errors handling. |
| |
| <p>The most common namespace URLs are defined in the <a href="Namespaces.html" title="class in org.apache.sis.xml"><code>Namespaces</code></a> class. |
| The parsing of some objects like <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URL</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>UUID</code></a>, |
| together with the behavior in case of parsing error, can be specified by the |
| <a href="ValueConverter.html" title="class in org.apache.sis.xml"><code>ValueConverter</code></a> class.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IdentifiedObject.html" title="interface in org.apache.sis.xml">IdentifiedObject</a></th> |
| <td class="colLast"> |
| <div class="block">The interface for all SIS objects having identifiers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IdentifierMap.html" title="interface in org.apache.sis.xml">IdentifierMap</a></th> |
| <td class="colLast"> |
| <div class="block">A map view of some or all identifiers in an <a href="IdentifiedObject.html" title="interface in org.apache.sis.xml">identified object</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IdentifierSpace.html" title="interface in org.apache.sis.xml">IdentifierSpace</a><T></th> |
| <td class="colLast"> |
| <div class="block">Some identifier namespaces that are handled in a special way.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NilObject.html" title="interface in org.apache.sis.xml">NilObject</a></th> |
| <td class="colLast"> |
| <div class="block">A marker interface for nil XML elements providing an explanation about why the information is absent.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a></th> |
| <td class="colLast"> |
| <div class="block">Context of a marshalling or unmarshalling process.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MarshallerPool.html" title="class in org.apache.sis.xml">MarshallerPool</a></th> |
| <td class="colLast"> |
| <div class="block">Creates and configures <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/Marshaller.html?is-external=true" title="class or interface in javax.xml.bind" class="externalLink"><code>Marshaller</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/Unmarshaller.html?is-external=true" title="class or interface in javax.xml.bind" class="externalLink"><code>Unmarshaller</code></a> objects for use with SIS.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Namespaces.html" title="class in org.apache.sis.xml">Namespaces</a></th> |
| <td class="colLast"> |
| <div class="block">Lists some namespaces URLs used by JAXB when (un)marshalling.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NilReason.html" title="class in org.apache.sis.xml">NilReason</a></th> |
| <td class="colLast"> |
| <div class="block">Explanation for a missing XML element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ReferenceResolver.html" title="class in org.apache.sis.xml">ReferenceResolver</a></th> |
| <td class="colLast"> |
| <div class="block">Controls the (un)marshaller behavior regarding the <code>xlink</code> or <code>uuidref</code> attributes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ValueConverter.html" title="class in org.apache.sis.xml">ValueConverter</a></th> |
| <td class="colLast"> |
| <div class="block">Performs conversions of XML element or attribute values encountered during XML (un)marshalling.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="XLink.html" title="class in org.apache.sis.xml">XLink</a></th> |
| <td class="colLast"> |
| <div class="block">The XML attributes defined by OGC in the |
| <a href="http://schemas.opengis.net/xlink/1.0.0/xlinks.xsd">xlink</a> schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="XML.html" title="class in org.apache.sis.xml">XML</a></th> |
| <td class="colLast"> |
| <div class="block">Provides convenience methods for marshalling and unmarshalling SIS objects.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a></th> |
| <td class="colLast"> |
| <div class="block">Communicates the desired timing of traversal from the starting resource to the ending |
| resource.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a></th> |
| <td class="colLast"> |
| <div class="block">Communicates the desired presentation of the ending resource on traversal |
| from the starting resource.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a></th> |
| <td class="colLast"> |
| <div class="block">The type of a <code>xlink</code>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
