| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.parameter (Apache SIS 1.4 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="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.referencing, package: org.apache.sis.parameter"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.parameter 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="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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="../../../../module-summary.html">Module</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li>Related Packages</li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li>Related Packages | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </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"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <h1 title="Package org.apache.sis.parameter" class="title">Package org.apache.sis.parameter</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.parameter</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Descriptions and values of parameters used by a coordinate operation or a process. |
| An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/package-summary.html" class="external-link">OpenGIS® javadoc</a>. |
| The remaining discussion on this page is specific to the SIS implementation. |
| |
| <p>There is three categories of classes in this package:</p> |
| <ul> |
| <li><b>Parameter descriptors</b> are immutable types that describes the parameters needed by an operation or a |
| process. Descriptors contain information like parameter name, optionality, repeatability and value type, but |
| do not contain the actual parameter value.</li> |
| <li><b>Parameter values</b> are (<var>descriptor</var>, <var>value</var>) tuples, together with convenience methods |
| for performing unit conversions and getting the values as instances of some commonly used types.</li> |
| <li><b>Builders</b>, <b>formatters</b> and search methods aim to simplify the creation of |
| <code>ParameterDescriptor</code>s, the search for parameter values and visualizing them in a tabular format.</li> |
| </ul> |
| |
| <p>Parameters are organized in <cite>groups</cite>. |
| A group may be for example the set of all parameters needed for the definition of a <cite>Mercator projection</cite>. |
| Parameter groups have some similarities with <code>java.util.Map</code> where:</p> |
| |
| <ul> |
| <li>Keys are (indirectly) parameter |
| <a href="../referencing/AbstractIdentifiedObject.html#getName()">names</a>.</li> |
| <li>Values are (indirectly) typically of type <code>int</code>, <code>int[]</code>, <code>double</code>, <code>double[]</code>, |
| <code>boolean</code>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a> or |
| <a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/citation/DefaultCitation.html" title="class in org.apache.sis.metadata.iso.citation"><code>Citation</code></a>.</li> |
| <li>Each parameter (equivalent to map entry) constraints the values to a base |
| <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>, |
| and optionally to a <a href="DefaultParameterDescriptor.html#getValueDomain()">value domain</a> (i.e. minimum and maximum valid values) or an enumeration of |
| <a href="DefaultParameterDescriptor.html#getValidValues()">valid values</a>.</li> |
| <li>Each parameter can have a |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> and a |
| <a href="DefaultParameterValue.html#getUnit()">unit of measurement</a>.</li> |
| <li>Some parameters are mandatory (<a href="AbstractParameterDescriptor.html#getMinimumOccurs()">minimum occurrence</a> = 1), meaning that they cannot be removed from the group. |
| They can be left to their default value however.</li> |
| <li>Group may contain other groups.</li> |
| </ul> |
| |
| <h2 id="usage-heading">Usage</h2> |
| When using this <code>org.apache.sis.parameter</code> package, the starting point is usually to obtain a |
| <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">parameter group descriptor</a> for |
| the operation of interest. Those groups are provided by the operation implementers, so users do not |
| need to create their own. |
| |
| <p>Given a group descriptor, users can obtain a new instance of parameter values by a call to the |
| <a href="DefaultParameterDescriptorGroup.html#createValue()"><code>createValue()</code></a> method. |
| New value groups initially contain all mandatory parameters with their default values and no optional parameter. |
| A <a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>parameter(String)</code></a> convenience |
| method is provided for fetching a parameter regardless of whether it was present or not — optional parameters |
| are created when first needed.</p> |
| |
| <h3 id="example-heading">Example</h3> |
| The following code snippet assumes that the implementer of a Mercator projection |
| provides a <code>ParameterDescriptorGroup</code> instance in a <code>PARAMETERS</code> static constant: |
| |
| |
| <div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../copy.svg" alt="Copy snippet"></button> |
| <pre class="snippet"><code class="language-java">ParameterValueGroup group = Mercator.PARAMETERS.createValue(); |
| group.parameter("Longitude of natural origin").setValue(-60); // Using default units (e.g. degrees). |
| group.parameter("False easting").setValue(200.0, Units.KILOMETRE); // Using explicit units. |
| </code></pre> |
| </div> |
| |
| |
| <h2 id="exceptions-heading">Exceptions</h2> |
| Calls to <code>parameter(…)</code> throw a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterNotFoundException.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterNotFoundException</code></a> |
| if the given name is unknown to the group. |
| Calls to <code>setValue(…)</code> throw a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/InvalidParameterValueException.html" title="class or interface in org.opengis.parameter" class="external-link"><code>InvalidParameterValueException</code></a> |
| if the given value is not assignable to the expected class or is not inside the value domain.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract definition of a parameter or group of parameters used by a coordinate operation or a process.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The definition of a single parameter used by an operation method.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptorGroup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The definition of a group of related parameters used by an operation method.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter">DefaultParameterValue</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A single parameter value used by an operation method.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">DefaultParameterValueGroup</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A group of related parameter values.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ParameterBuilder.html" title="class in org.apache.sis.parameter">ParameterBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Helper class for <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">parameter descriptor</a> instantiations.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ParameterFormat.html" title="class in org.apache.sis.parameter">ParameterFormat</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Formats <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">parameter descriptors</a> or |
| <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">parameter values</a> in a tabular format.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ParameterFormat.ContentLevel.html" title="enum class in org.apache.sis.parameter">ParameterFormat.ContentLevel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">The amount of information to include in the table formatted by <a href="ParameterFormat.html" title="class in org.apache.sis.parameter"><code>ParameterFormat</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Parameterized.html" title="interface in org.apache.sis.parameter">Parameterized</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">An object which can supply its parameters in a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link"><code>ParameterValueGroup</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Convenience methods for fetching parameter values despite the variations in parameter names, value types and units.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TensorParameters.html" title="class in org.apache.sis.parameter">TensorParameters</a><E></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates parameter groups for tensors (usually matrices).</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
