| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultParameterDescriptor (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.parameter.DefaultParameterDescriptor class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="getInterface()"> |
| <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="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultParameterDescriptor (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.parameter</a></div> |
| <h2 title="Class DefaultParameterDescriptor" class="title">Class DefaultParameterDescriptor<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>DefaultParameterDescriptor<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></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> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</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/parameter/GeneralParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterDescriptor</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><T></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DefaultParameterDescriptor<T></span> |
| 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/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><T></pre> |
| <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/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a>, <code>double[]</code>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Integer</code></a>, <code>int[]</code>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValue</code></a>, |
| <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterDescriptorGroup</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.parameter.DefaultParameterDescriptor">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.AbstractIdentifiedObject"> |
| <!-- --> |
| </a> |
| <h3>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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.IdentifiedObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">ALIAS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">IDENTIFIERS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#NAME_KEY" title="class or interface in org.opengis.referencing" class="externalLink">NAME_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">REMARKS_KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,T%5B%5D,T)">DefaultParameterDescriptor</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties, |
| int minimumOccurs, |
| int maximumOccurs, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">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></th> |
| <td class="colLast"> |
| <div class="block">Constructs a descriptor from the given properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.parameter.ParameterDescriptor)">DefaultParameterDescriptor</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> descriptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new descriptor with the same values than the specified one.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.parameter.ParameterDescriptor)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><T> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS parameter implementation with the same values than the given arbitrary implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeHashCode()">computeHashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createValue()">createValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new parameter value instance initialized with the <a href="#getDefaultValue()">default value</a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object, |
| <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a> mode)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares the specified object with this parameter for equality.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultValue()">getDefaultValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default value for the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterface()">getInterface</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the GeoAPI interface implemented by this class.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaximumValue()">getMaximumValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinimumValue()">getMinimumValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum parameter value.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnit()">getUnit</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValidValues()">getValidValues</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this parameter allows only a finite set of values, returns that set.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueClass()">getValueClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the class that describe the type of the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueDomain()">getValueDomain</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the domain of values with their unit of measurement (if any), or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.AbstractParameterDescriptor"> |
| <!-- --> |
| </a> |
| <h3>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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.AbstractIdentifiedObject"> |
| <!-- --> |
| </a> |
| <h3>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#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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.FormattableObject"> |
| <!-- --> |
| </a> |
| <h3>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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.GeneralParameterDescriptor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterDescriptor</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterDescriptor.html?is-external=true#getMaximumOccurs()" title="class or interface in org.opengis.parameter" class="externalLink">getMaximumOccurs</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterDescriptor.html?is-external=true#getMinimumOccurs()" title="class or interface in org.opengis.parameter" class="externalLink">getMinimumOccurs</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.IdentifiedObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getAlias()" title="class or interface in org.opengis.referencing" class="externalLink">getAlias</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getIdentifiers()" title="class or interface in org.opengis.referencing" class="externalLink">getIdentifiers</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getName()" title="class or interface in org.opengis.referencing" class="externalLink">getName</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#getRemarks()" title="class or interface in org.opengis.referencing" class="externalLink">getRemarks</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#toWKT()" title="class or interface in org.opengis.referencing" class="externalLink">toWKT</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,java.lang.Object[],java.lang.Object)"> |
| <!-- --> |
| </a><a id="<init>(java.util.Map,int,int,java.lang.Class,org.apache.sis.measure.Range,T[],T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultParameterDescriptor</h4> |
| <pre>public DefaultParameterDescriptor​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties, |
| int minimumOccurs, |
| int maximumOccurs, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">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)</pre> |
| <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/referencing/IdentifiedObject.html?is-external=true#NAME_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"name"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ReferenceIdentifier</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><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/referencing/IdentifiedObject.html?is-external=true#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"alias"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><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/referencing/IdentifiedObject.html?is-external=true#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"identifiers"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><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/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><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/referencing/IdentifiedObject.html?is-external=true#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"remarks"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><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 equals |
| to one of the following: |
| <ul> |
| <li>to <code>valueClass</code> if the later 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/javase/8/docs/api/java/lang/Class.html?is-external=true#getComponentType()" title="class or interface in java.lang" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></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/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><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/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultParameterDescriptor</h4> |
| <pre>protected DefaultParameterDescriptor​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> descriptor)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - the descriptor to shallow copy.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#castOrCopy(org.opengis.parameter.ParameterDescriptor)"><code>castOrCopy(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="castOrCopy(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <T> <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a><T> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><T> object)</pre> |
| <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> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of values.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="getInterface()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterface</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>>> getInterface()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ParameterDescriptor.class</code> or a user-defined sub-interface.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValueClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueClass</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> getValueClass()</pre> |
| <div class="block">Returns the class that describe the type of the parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getValueClass()" title="class or interface in org.opengis.parameter" class="externalLink">getValueClass</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter value class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValidValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidValues</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> getValidValues()</pre> |
| <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/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">code list</a> or enumeration. |
| This method returns <code>null</code> if this parameter does not limit values to a finite set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getValidValues()" title="class or interface in org.opengis.parameter" class="externalLink">getValidValues</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a finite set of valid values (usually from a <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">code list</a>), |
| or <code>null</code> if it does not apply or if there is no restriction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValueDomain()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueDomain</h4> |
| <pre class="methodSignature">public final <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?> getValueDomain()</pre> |
| <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 contains also 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/javase/8/docs/api/java/lang/Class.html?is-external=true#getComponentType()" title="class or interface in java.lang" class="externalLink">component |
| type</a> of <code><T></code> (using wrapper classes for primitive types).</div></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the domain of values, or <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Parameters.html#getValueDomain(org.opengis.parameter.ParameterDescriptor)"><code>Parameters.getValueDomain(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMinimumValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinimumValue</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> getMinimumValue()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getMinimumValue()" title="class or interface in org.opengis.parameter" class="externalLink">getMinimumValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum parameter value (often an instance of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a>), or <code>null</code> if unbounded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaximumValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumValue</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> getMaximumValue()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getMaximumValue()" title="class or interface in org.opengis.parameter" class="externalLink">getMaximumValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum parameter value (often an instance of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a>), or <code>null</code> if unbounded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefaultValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultValue</h4> |
| <pre class="methodSignature">public <a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a> getDefaultValue()</pre> |
| <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/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Number</code></a> or a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a>. If there is no default value, |
| then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getDefaultValue()" title="class or interface in org.opengis.parameter" class="externalLink">getDefaultValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default value, or <code>null</code> in none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUnit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnit</h4> |
| <pre class="methodSignature">public <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true" title="class or interface in javax.measure" class="externalLink">Unit</a><?> getUnit()</pre> |
| <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/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#getUnit()" title="class or interface in org.opengis.parameter" class="externalLink">getUnit</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unit for numeric value, or <code>null</code> if it doesn't apply to the value type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createValue</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValue</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>> createValue()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterDescriptor.html?is-external=true#createValue()" title="class or interface in org.opengis.parameter" class="externalLink">createValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterDescriptor</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true#createValue()" title="class or interface in org.opengis.parameter" class="externalLink">createValue</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptor</a><<a href="DefaultParameterDescriptor.html" title="type parameter in DefaultParameterDescriptor">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a parameter initialized to the default value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object, |
| <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a> mode)</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></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><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if both objects are equal according the given comparison mode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../referencing/AbstractIdentifiedObject.html#computeHashCode()"><code>AbstractIdentifiedObject.computeHashCode()</code></a>, |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="computeHashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>computeHashCode</h4> |
| <pre class="methodSignature">protected long computeHashCode()</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the hash code value. This value may change in any future Apache SIS version.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |