| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>DefaultParameterDescriptor (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="declaration: package: org.apache.sis.parameter, class: DefaultParameterDescriptor"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.parameter.DefaultParameterDescriptor class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="getInterface()"> |
| <meta name="keywords" content="getValueType()"> |
| <meta name="keywords" content="getValueClass()"> |
| <meta name="keywords" content="getValidValues()"> |
| <meta name="keywords" content="getValueDomain()"> |
| <meta name="keywords" content="getMinimumValue()"> |
| <meta name="keywords" content="getMaximumValue()"> |
| <meta name="keywords" content="getDefaultValue()"> |
| <meta name="keywords" content="getUnit()"> |
| <meta name="keywords" content="createValue()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="computeHashCode()"> |
| <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-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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/DefaultParameterDescriptor.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.parameter</a></div> |
| <h1 title="Class DefaultParameterDescriptor" class="title">Class DefaultParameterDescriptor<T></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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> |
| <div class="inheritance"><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a> |
| <div class="inheritance"><a href="../referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a> |
| <div class="inheritance"><a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a> |
| <div class="inheritance">DefaultParameterDescriptor<T></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of elements to be returned by <a href="DefaultParameterValue.html#getValue()"><code>DefaultParameterValue.getValue()</code></a>.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Formattable.html" title="class or interface in java.util" class="external-link">Formattable</a></code>, <code><a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code>, <code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultParameterDescriptor<T></span> |
| <span class="extends-implements">extends <a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T></span></div> |
| <div class="block">The definition of a single parameter used by an operation method. |
| For <a href="../referencing/crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference Systems</a> |
| most parameter values are numeric, but other types of parameter values are possible. |
| |
| <p>A parameter descriptor contains the following properties:</p> |
| <ul> |
| <li>The parameter <a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a>.</li> |
| <li>The <a href="#getValueClass()">class of values</a>. This is usually <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a>, <code>double[]</code>, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a>, <code>int[]</code>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a>, <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"><code>String</code></a> or <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"><code>URI</code></a>, |
| but other types are allowed as well.</li> |
| <li>Whether this parameter is optional or mandatory. This is specified by the <a href="AbstractParameterDescriptor.html#getMinimumOccurs()">minimum occurences</a> number, which can be 0 or 1 respectively.</li> |
| <li>The domain of values, as a <a href="#getMinimumValue()">minimum value</a>, <a href="#getMaximumValue()">maximum value</a> or an enumeration of <a href="#getValidValues()">valid values</a>.</li> |
| <li>The <a href="#getDefaultValue()">default value</a>.</li> |
| <li>The <a href="#getUnit()">unit of measurement</a>.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValue</code></a></li> |
| <li><a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterDescriptorGroup</code></a></li> |
| <li><a href="../../../../serialized-form.html#org.apache.sis.parameter.DefaultParameterDescriptor">Serialized Form</a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-AbstractIdentifiedObject">Fields inherited from class <a href="../referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../referencing/AbstractIdentifiedObject.html#DEPRECATED_KEY">DEPRECATED_KEY</a>, <a href="../referencing/AbstractIdentifiedObject.html#LOCALE_KEY">LOCALE_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-IdentifiedObject">Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">ALIAS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">IDENTIFIERS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">NAME_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">REMARKS_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,T%5B%5D,T)" class="member-name-link">DefaultParameterDescriptor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>?> properties, |
| int minimumOccurs, |
| int maximumOccurs, |
| <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><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> valueClass, |
| <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?> valueDomain, |
| <a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>[] validValues, |
| <a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a> defaultValue)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a descriptor from the given properties.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">DefaultParameterDescriptor</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> descriptor)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new descriptor with the same values than the specified one.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T> <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#castOrCopy(org.opengis.parameter.ParameterDescriptor)" class="member-name-link">castOrCopy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a SIS parameter implementation with the same values than the given arbitrary implementation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeHashCode()" class="member-name-link">computeHashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked by <a href="../referencing/AbstractIdentifiedObject.html#hashCode()"><code>AbstractIdentifiedObject.hashCode()</code></a> for computing the hash code when first needed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createValue()" class="member-name-link">createValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new parameter value instance initialized with the <a href="#getDefaultValue()">default value</a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)" class="member-name-link">equals</a><wbr>(<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> object, |
| <a href="../util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a> mode)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares the specified object with this parameter for equality.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultValue()" class="member-name-link">getDefaultValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the default value for the parameter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInterface()" class="member-name-link">getInterface</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the GeoAPI interface implemented by this class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumValue()" class="member-name-link">getMaximumValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum parameter value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinimumValue()" class="member-name-link">getMinimumValue</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum parameter value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><?></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnit()" class="member-name-link">getUnit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the unit of measurement for the |
| <a href="#getMinimumValue()">minimum</a>, |
| <a href="#getMaximumValue()">maximum</a> and |
| <a href="#getDefaultValue()">default</a> values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValidValues()" class="member-name-link">getValidValues</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If this parameter allows only a finite set of values, returns that set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueClass()" class="member-name-link">getValueClass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the class that describes the type of parameter values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueDomain()" class="member-name-link">getValueDomain</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the domain of values with their unit of measurement (if any), or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueType()" class="member-name-link">getValueType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name that describes the type of parameter values.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractParameterDescriptor">Methods inherited from class <a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></h3> |
| <code><a href="AbstractParameterDescriptor.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a>, <a href="AbstractParameterDescriptor.html#getMaximumOccurs()">getMaximumOccurs</a>, <a href="AbstractParameterDescriptor.html#getMinimumOccurs()">getMinimumOccurs</a>, <a href="AbstractParameterDescriptor.html#print()">print</a>, <a href="AbstractParameterDescriptor.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractIdentifiedObject">Methods inherited from class <a href="../referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../referencing/AbstractIdentifiedObject.html#castOrCopy(org.opengis.referencing.IdentifiedObject)">castOrCopy</a>, <a href="../referencing/AbstractIdentifiedObject.html#equals(java.lang.Object)">equals</a>, <a href="../referencing/AbstractIdentifiedObject.html#formatTo(java.util.Formatter,int,int,int)">formatTo</a>, <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">getAlias</a>, <a href="../referencing/AbstractIdentifiedObject.html#getDescription()">getDescription</a>, <a href="../referencing/AbstractIdentifiedObject.html#getIdentifiers()">getIdentifiers</a>, <a href="../referencing/AbstractIdentifiedObject.html#getName()">getName</a>, <a href="../referencing/AbstractIdentifiedObject.html#getRemarks()">getRemarks</a>, <a href="../referencing/AbstractIdentifiedObject.html#hashCode()">hashCode</a>, <a href="../referencing/AbstractIdentifiedObject.html#isDeprecated()">isDeprecated</a>, <a href="../referencing/AbstractIdentifiedObject.html#isHeuristicMatchForName(java.lang.String)">isHeuristicMatchForName</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-FormattableObject">Methods inherited from class <a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3> |
| <code><a href="../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-GeneralParameterDescriptor">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html#getMaximumOccurs()" title="class or interface in org.opengis.parameter" class="external-link">getMaximumOccurs</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html#getMinimumOccurs()" title="class or interface in org.opengis.parameter" class="external-link">getMinimumOccurs</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-IdentifiedObject">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getAlias()" title="class or interface in org.opengis.referencing" class="external-link">getAlias</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getIdentifiers()" title="class or interface in org.opengis.referencing" class="external-link">getIdentifiers</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getName()" title="class or interface in org.opengis.referencing" class="external-link">getName</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getRemarks()" title="class or interface in org.opengis.referencing" class="external-link">getRemarks</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#toWKT()" title="class or interface in org.opengis.referencing" class="external-link">toWKT</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,T[],T)"> |
| <h3 id="<init>(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,java.lang.Object[],java.lang.Object)">DefaultParameterDescriptor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultParameterDescriptor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>?> properties, |
| int minimumOccurs, |
| int maximumOccurs, |
| <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><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> valueClass, |
| <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?> valueDomain, |
| <a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>[] validValues, |
| <a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a> defaultValue)</span></div> |
| <div class="block">Constructs a descriptor from the given properties. The properties map is given unchanged to the |
| <a href="AbstractParameterDescriptor.html#%3Cinit%3E(java.util.Map,int,int)">super-class constructor</a>. |
| The following table is a reminder of main (not all) properties: |
| |
| <table class="sis"> |
| <caption>Recognized properties (non exhaustive list)</caption> |
| <tr> |
| <th>Property name</th> |
| <th>Value type</th> |
| <th>Returned by</th> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">"name"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceIdentifier.html" title="class or interface in org.opengis.referencing" class="external-link"><code>ReferenceIdentifier</code></a> or <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"><code>String</code></a></td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"alias"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> or <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"><code>CharSequence</code></a> (optionally as array)</td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getAlias()"><code>AbstractIdentifiedObject.getAlias()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"identifiers"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceIdentifier.html" title="class or interface in org.opengis.referencing" class="external-link"><code>ReferenceIdentifier</code></a> (optionally as array)</td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getIdentifiers()"><code>AbstractIdentifiedObject.getIdentifiers()</code></a></td> |
| </tr> |
| <tr> |
| <td>"description"</td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <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"><code>String</code></a></td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getDescription()"><code>AbstractIdentifiedObject.getDescription()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"remarks"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <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"><code>String</code></a></td> |
| <td><a href="../referencing/AbstractIdentifiedObject.html#getRemarks()"><code>AbstractIdentifiedObject.getRemarks()</code></a></td> |
| </tr> |
| </table> |
| |
| The <code>valueDomain</code> argument combines the <a href="#getMinimumValue()">minimum value</a>, |
| <a href="#getMaximumValue()">maximum value</a>, <a href="#getUnit()">unit of measurement</a> |
| (if any) and information about whether the bounds are inclusive or exclusive. |
| If this argument is non-null, then it shall comply to the following conditions: |
| |
| <ul> |
| <li>The range shall be non-<a href="../measure/Range.html#isEmpty()">empty</a>.</li> |
| <li><code>valueDomain.<a href="../measure/Range.html#getElementType()">getElementType()</a></code> shall be equal |
| to one of the following: |
| <ul> |
| <li>to <code>valueClass</code> if the latter is not an array,</li> |
| <li>or to <code><a href="../util/Numbers.html#primitiveToWrapper(java.lang.Class)">primitiveToWrapper</a>(valueClass.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html#getComponentType()" title="class or interface in java.lang" class="external-link">getComponentType()</a>)</code> |
| if <code>valueClass</code> is an array.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| If both <code>valueDomain</code> and <code>validValues</code> are non-null, then all valid values shall be contained |
| in the value domain.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - the properties to be given to the identified object.</dd> |
| <dd><code>minimumOccurs</code> - the <a href="AbstractParameterDescriptor.html#getMinimumOccurs()">minimum number of times</a> that values |
| for this parameter group are required, or 0 if no restriction.</dd> |
| <dd><code>maximumOccurs</code> - the <a href="AbstractParameterDescriptor.html#getMaximumOccurs()">maximum number of times</a> that values |
| for this parameter group are required, or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if no restriction.</dd> |
| <dd><code>valueClass</code> - the class that describes the type of the parameter value.</dd> |
| <dd><code>valueDomain</code> - the minimum value, maximum value and unit of measurement, or <code>null</code> if none.</dd> |
| <dd><code>validValues</code> - the list of valid values, or <code>null</code> if there is no restriction. |
| This property is mostly for restricting values to a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">code list</a> |
| or enumeration subset. It is not necessary to provide this property when all values |
| from the code list or enumeration are valid.</dd> |
| <dd><code>defaultValue</code> - the default value for the parameter, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>DefaultParameterDescriptor</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">DefaultParameterDescriptor</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> descriptor)</span></div> |
| <div class="block">Creates a new descriptor with the same values than the specified one. |
| This copy constructor provides a way to convert an arbitrary implementation into a SIS one or a |
| user-defined one (as a subclass), usually in order to leverage some implementation-specific API. |
| |
| <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>descriptor</code> - the descriptor to shallow copy.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#castOrCopy(org.opengis.parameter.ParameterDescriptor)"><code>castOrCopy(ParameterDescriptor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="castOrCopy(org.opengis.parameter.ParameterDescriptor)"> |
| <h3>castOrCopy</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a><T></span> <span class="element-name">castOrCopy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><T> object)</span></div> |
| <div class="block">Returns a SIS parameter implementation with the same values than the given arbitrary implementation. |
| If the given object is <code>null</code>, then this method returns <code>null</code>. |
| Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. |
| Otherwise a new SIS implementation is created and initialized to the values of the given object.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of values.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>a SIS implementation containing the values of the given object (may be the |
| given object itself), or <code>null</code> if the argument was null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInterface()"> |
| <h3>getInterface</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><? extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>>></span> <span class="element-name">getInterface</span>()</div> |
| <div class="block">Returns the GeoAPI interface implemented by this class. |
| The SIS implementation returns <code>ParameterDescriptor.class</code>. |
| |
| <div class="note"><b>Note for implementers:</b> |
| Subclasses usually do not need to override this method since GeoAPI does not define <code>ParameterDescriptor</code> |
| sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own |
| set of interfaces.</div></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractParameterDescriptor.html#getInterface()">getInterface</a></code> in class <code><a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd><code>ParameterDescriptor.class</code> or a user-defined sub-interface.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueType()"> |
| <h3>getValueType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/TypeName.html" title="class or interface in org.opengis.util" class="external-link">TypeName</a></span> <span class="element-name">getValueType</span>()</div> |
| <div class="block">Returns the name that describes the type of parameter values. |
| This is closely related to the <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"><code>Class</code></a> returned by <a href="#getValueClass()"><code>getValueClass()</code></a>: |
| |
| <ul> |
| <li>If the value class is a collection (e.g. <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link"><code>List</code></a> or array), |
| then this method returns the type of <em>elements</em> in the collection.</li> |
| <li>Otherwise this method returns the value class using the mapping documented in |
| <a href="../util/iso/DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> javadoc.</li> |
| </ul> |
| |
| <code>TypeName</code> is used for encoding parameters in XML or JSON documents, |
| while <a href="#getValueClass()"><code>getValueClass()</code></a> is used for programmatic purposes.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the type name of value component(s) in this parameter.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueClass()"> |
| <h3>getValueClass</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></span> <span class="element-name">getValueClass</span>()</div> |
| <div class="block">Returns the class that describes the type of parameter values.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getValueClass()" title="class or interface in org.opengis.parameter" class="external-link">getValueClass</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the parameter value class.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValidValues()"> |
| <h3>getValidValues</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></span> <span class="element-name">getValidValues</span>()</div> |
| <div class="block">If this parameter allows only a finite set of values, returns that set. |
| The set of valid values is usually a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">code list</a> or enumeration. |
| This method returns <code>null</code> if this parameter does not limit values to a finite set.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getValidValues()" title="class or interface in org.opengis.parameter" class="external-link">getValidValues</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>a finite set of valid values (usually from a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">code list</a>), |
| or <code>null</code> if it does not apply or if there is no restriction.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueDomain()"> |
| <h3>getValueDomain</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?></span> <span class="element-name">getValueDomain</span>()</div> |
| <div class="block">Returns the domain of values with their unit of measurement (if any), or <code>null</code> if none. |
| The <code>Range</code> object combines the <a href="#getValueClass()">value class</a>, |
| <a href="#getMinimumValue()">minimum value</a>, <a href="#getMaximumValue()">maximum value</a> |
| and whether these values are inclusive or inclusive. If the range is an instance of |
| <a href="../measure/MeasurementRange.html" title="class in org.apache.sis.measure"><code>MeasurementRange</code></a>, then it also contains the <a href="#getUnit()">unit of measurement</a>. |
| |
| <div class="note"><b>API note:</b> If this method returns a non-null value, then its type is either exactly |
| <code>Range<T></code>, or <code>Range<E></code> where <code><E></code> is the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html#getComponentType()" title="class or interface in java.lang" class="external-link">component |
| type</a> of <code><T></code> (using wrapper classes for primitive types).</div></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the domain of values, or <code>null</code>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="Parameters.html#getValueDomain(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.getValueDomain(ParameterDescriptor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinimumValue()"> |
| <h3>getMinimumValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></span> <span class="element-name">getMinimumValue</span>()</div> |
| <div class="block">Returns the minimum parameter value. If there is no minimum value, or if minimum |
| value is inappropriate for the <a href="#getValueClass()">value class</a>, then |
| this method returns <code>null</code>. |
| |
| <p>This is a convenience method for |
| <code><a href="#getValueDomain()">getValueDomain()</a>.<a href="../measure/Range.html#getMinValue()">getMinValue()</a></code>. |
| Note that this method said nothing about whether the value is <a href="../measure/Range.html#isMinIncluded()">inclusive</a>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getMinimumValue()" title="class or interface in org.opengis.parameter" class="external-link">getMinimumValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum parameter value (often an instance of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a>), or <code>null</code> if unbounded.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaximumValue()"> |
| <h3>getMaximumValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></span> <span class="element-name">getMaximumValue</span>()</div> |
| <div class="block">Returns the maximum parameter value. If there is no maximum value, or if maximum |
| value is inappropriate for the <a href="#getValueClass()">value type</a>, then |
| this method returns <code>null</code>. |
| |
| <p>This is a convenience method for |
| <code><a href="#getValueDomain()">getValueDomain()</a>.<a href="../measure/Range.html#getMaxValue()">getMaxValue()</a></code>. |
| Note that this method said nothing about whether the value is <a href="../measure/Range.html#isMaxIncluded()">inclusive</a>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getMaximumValue()" title="class or interface in org.opengis.parameter" class="external-link">getMaximumValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the minimum parameter value (often an instance of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a>), or <code>null</code> if unbounded.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDefaultValue()"> |
| <h3>getDefaultValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a></span> <span class="element-name">getDefaultValue</span>()</div> |
| <div class="block">Returns the default value for the parameter. The return type can be any type |
| including a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link"><code>Number</code></a> or a <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"><code>String</code></a>. If there is no default value, |
| then this method returns <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getDefaultValue()" title="class or interface in org.opengis.parameter" class="external-link">getDefaultValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the default value, or <code>null</code> in none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnit()"> |
| <h3>getUnit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><?></span> <span class="element-name">getUnit</span>()</div> |
| <div class="block">Returns the unit of measurement for the |
| <a href="#getMinimumValue()">minimum</a>, |
| <a href="#getMaximumValue()">maximum</a> and |
| <a href="#getDefaultValue()">default</a> values. |
| This attribute apply only if the values is of numeric type (usually an instance of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a>). |
| |
| <p>This is a convenience method for |
| <code><a href="#getValueDomain()">getValueDomain()</a>.<a href="../measure/MeasurementRange.html#unit()">unit()</a></code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#getUnit()" title="class or interface in org.opengis.parameter" class="external-link">getUnit</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the unit for numeric value, or <code>null</code> if it doesn't apply to the value type.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createValue()"> |
| <h3>createValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValue.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValue</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></span> <span class="element-name">createValue</span>()</div> |
| <div class="block">Creates a new parameter value instance initialized with the <a href="#getDefaultValue()">default value</a>. |
| The <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">parameter descriptor</a> for the created parameter value will be |
| <code>this</code> object.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html#createValue()" title="class or interface in org.opengis.parameter" class="external-link">createValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/GeneralParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">GeneralParameterDescriptor</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html#createValue()" title="class or interface in org.opengis.parameter" class="external-link">createValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterDescriptor.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>a parameter initialized to the default value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> object, |
| <a href="../util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a> mode)</span></div> |
| <div class="block">Compares the specified object with this parameter for equality. |
| The strictness level is controlled by the second argument. |
| This method compares the following properties in every cases: |
| |
| <ul> |
| <li><a href="../referencing/AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a>, compared <a href="../referencing/AbstractIdentifiedObject.html#isHeuristicMatchForName(java.lang.String)">heuristically</a> |
| in <code>IGNORE_METADATA</code> or less strict mode.</li> |
| <li><a href="#getValueClass()"><code>getValueClass()</code></a></li> |
| <li><a href="#getDefaultValue()"><code>getDefaultValue()</code></a></li> |
| <li><a href="#getUnit()"><code>getUnit()</code></a></li> |
| </ul> |
| |
| All other properties (minimum and maximum occurrences, minimum, maximum and valid values) |
| are compared only for modes stricter than <a href="../util/ComparisonMode.html#IGNORE_METADATA"><code>ComparisonMode.IGNORE_METADATA</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code> in interface <code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractParameterDescriptor.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code> in class <code><a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to compare to <code>this</code>.</dd> |
| <dd><code>mode</code> - the strictness level of the comparison.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if both objects are equal according the given comparison mode.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../referencing/AbstractIdentifiedObject.html#computeHashCode()"><code>AbstractIdentifiedObject.computeHashCode()</code></a></li> |
| <li><a href="../util/Utilities.html#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>Utilities.deepEquals(Object, Object, ComparisonMode)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeHashCode()"> |
| <h3>computeHashCode</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">computeHashCode</span>()</div> |
| <div class="block">Invoked by <a href="../referencing/AbstractIdentifiedObject.html#hashCode()"><code>AbstractIdentifiedObject.hashCode()</code></a> for computing the hash code when first needed.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../referencing/AbstractIdentifiedObject.html#computeHashCode()">computeHashCode</a></code> in class <code><a href="../referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the hash code value. This value may change in any future Apache SIS version.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |