blob: 5383af76574bff5d1563dabe018f4254bbdc0689 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>Uses of Class org.apache.sis.xml.MarshalContext (Apache SIS 1.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.sis.xml, class: MarshalContext">
<meta name="generator" content="javadoc/ClassUseWriter">
<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="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../MarshalContext.html" title="class in org.apache.sis.xml">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.sis.xml.MarshalContext" class="title">Uses of Class<br>org.apache.sis.xml.MarshalContext</h1>
</div>
<div class="caption"><span>Packages that use <a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.sis.xml">org.apache.sis.xml</a></div>
<div class="col-last even-row-color">
<div class="block">Provides methods for marshalling and unmarshalling SIS objects in XML.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.sis.xml">
<h2>Uses of <a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a> in <a href="../package-summary.html">org.apache.sis.xml</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.sis.xml</a> with parameters of type <a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../XLink.html" title="class in org.apache.sis.xml">XLink</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#anchor(org.apache.sis.xml.MarshalContext,java.lang.Object,java.lang.CharSequence)" class="member-name-link">anchor</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;text)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns the <code>&lt;gcx:Anchor&gt;</code> to use for the given text, or <code>null</code> if none.</div>
</div>
<div class="col-first odd-row-color"><code>&lt;T&gt;&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#canSubstituteByReference(org.apache.sis.xml.MarshalContext,java.lang.Class,T,java.lang.String)" class="member-name-link">canSubstituteByReference</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
T&nbsp;object,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns <code>true</code> if the marshaller can use a <code>xlink:href="#id"</code> reference to the given object
instead of writing the full XML element.</div>
</div>
<div class="col-first even-row-color"><code>&lt;T&gt;&nbsp;boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#canSubstituteByReference(org.apache.sis.xml.MarshalContext,java.lang.Class,T,java.util.UUID)" class="member-name-link">canSubstituteByReference</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
T&nbsp;object,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;uuid)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns <code>true</code> if the marshaller can use a reference to the given object
instead of writing the full XML element.</div>
</div>
<div class="col-first odd-row-color"><code>&lt;T&gt;&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#canSubstituteByReference(org.apache.sis.xml.MarshalContext,java.lang.Class,T,org.apache.sis.xml.XLink)" class="member-name-link">canSubstituteByReference</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
T&nbsp;object,
<a href="../XLink.html" title="class in org.apache.sis.xml">XLink</a>&nbsp;link)</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns <code>true</code> if the marshaller can use a <code>xlink:href</code> reference to the given
object instead of writing the full XML element.</div>
</div>
<div class="col-first even-row-color"><code>protected &lt;T&gt;&nbsp;boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#exceptionOccured(org.apache.sis.xml.MarshalContext,T,java.lang.Class,java.lang.Class,java.lang.Exception)" class="member-name-link">exceptionOccured</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
T&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;sourceType,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&nbsp;targetType,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a>&nbsp;exception)</code></div>
<div class="col-last even-row-color">
<div class="block">Invoked when an exception occurred in any <code>toXXX(…)</code> method.</div>
</div>
<div class="col-first odd-row-color"><code>&lt;T&gt;&nbsp;T</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#newIdentifiedObject(org.apache.sis.xml.MarshalContext,java.lang.Class,org.opengis.metadata.Identifier...)" class="member-name-link">newIdentifiedObject</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link">Identifier</a>...&nbsp;identifiers)</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns an empty object of the given type having the given identifiers.</div>
</div>
<div class="col-first even-row-color"><code>&lt;T&gt;&nbsp;T</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#resolve(org.apache.sis.xml.MarshalContext,java.lang.Class,java.util.UUID)" class="member-name-link">resolve</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>&nbsp;uuid)</code></div>
<div class="col-last even-row-color">
<div class="block">Returns an object of the given type for the given <code>uuid</code> attribute, or <code>null</code> if none.</div>
</div>
<div class="col-first odd-row-color"><code>&lt;T&gt;&nbsp;T</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ReferenceResolver.</span><code><a href="../ReferenceResolver.html#resolve(org.apache.sis.xml.MarshalContext,java.lang.Class,org.apache.sis.xml.XLink)" class="member-name-link">resolve</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type,
<a href="../XLink.html" title="class in org.apache.sis.xml">XLink</a>&nbsp;link)</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns an object of the given type for the given <code>xlink</code> attribute, or <code>null</code> if none.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toCharset(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toCharset</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given string to a character set.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toCharsetCode(org.apache.sis.xml.MarshalContext,java.nio.charset.Charset)" class="member-name-link">toCharsetCode</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color">
<div class="block">Converts the given character set to a code.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toCountryCode(org.apache.sis.xml.MarshalContext,java.util.Locale)" class="member-name-link">toCountryCode</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given locale to a country code.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toLanguageCode(org.apache.sis.xml.MarshalContext,java.util.Locale)" class="member-name-link">toLanguageCode</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color">
<div class="block">Converts the given locale to a language code.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toLocale(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toLocale</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given string to a locale.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../NilReason.html" title="class in org.apache.sis.xml">NilReason</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toNilReason(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toNilReason</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color">
<div class="block">Converts the given string to a <code>NilReason</code>.</div>
</div>
<div class="col-first even-row-color"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html" title="class or interface in javax.measure" class="external-link">Unit</a>&lt;?&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toUnit(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toUnit</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given string to a unit.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toURI(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toURI</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color">
<div class="block">Converts the given string to a URI.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toURI(org.apache.sis.xml.MarshalContext,java.net.URL)" class="member-name-link">toURI</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given URL to a URI.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link">URL</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toURL(org.apache.sis.xml.MarshalContext,java.net.URI)" class="member-name-link">toURL</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color">
<div class="block">Converts the given URI to a URL.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ValueConverter.</span><code><a href="../ValueConverter.html#toUUID(org.apache.sis.xml.MarshalContext,java.lang.String)" class="member-name-link">toUUID</a><wbr>(<a href="../MarshalContext.html" title="class in org.apache.sis.xml">MarshalContext</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last even-row-color">
<div class="block">Converts the given string to a Universal Unique Identifier.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>