| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Parameters (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.Parameters class"> |
| <meta name="keywords" content="unmodifiable()"> |
| <meta name="keywords" content="castOrWrap()"> |
| <meta name="keywords" content="cast()"> |
| <meta name="keywords" content="getDescriptors()"> |
| <meta name="keywords" content="getMemberName()"> |
| <meta name="keywords" content="getValueDomain()"> |
| <meta name="keywords" content="getValue()"> |
| <meta name="keywords" content="getMandatoryValue()"> |
| <meta name="keywords" content="booleanValue()"> |
| <meta name="keywords" content="intValue()"> |
| <meta name="keywords" content="intValueList()"> |
| <meta name="keywords" content="doubleValue()"> |
| <meta name="keywords" content="doubleValueList()"> |
| <meta name="keywords" content="stringValue()"> |
| <meta name="keywords" content="getOrCreate()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="copy()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="print()"> |
| <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="Parameters (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":10,"i5":9,"i6":10,"i7":10,"i8":9,"i9":10,"i10":9,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9}; |
| 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/Parameters.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>Field | </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 Parameters" class="title">Class Parameters</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>Parameters</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../referencing/operation/transform/ContextualParameters.html" title="class in org.apache.sis.referencing.operation.transform">ContextualParameters</a></code>, <code><a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">DefaultParameterValueGroup</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">Parameters</span> |
| extends <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> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre> |
| <div class="block">Convenience methods for fetching parameter values despite the variations in parameter names, value types and units. |
| See <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValueGroup</code></a> javadoc for a description of the standard way to get and set a particular |
| parameter in a group. The remaining of this javadoc is specific to Apache SIS. |
| |
| <div class="section">Convenience methods</div> |
| This class provides the following convenience static methods: |
| <ul> |
| <li><a href="#cast(org.opengis.parameter.ParameterValue,java.lang.Class)"><code>cast(…, Class)</code></a> for type safety with parameterized types.</li> |
| <li><a href="#getMemberName(org.opengis.parameter.ParameterDescriptor)"><code>getMemberName(ParameterDescriptor)</code></a> for inter-operability between ISO 19111 and ISO 19115.</li> |
| <li><a href="#getValueDomain(org.opengis.parameter.ParameterDescriptor)"><code>getValueDomain(ParameterDescriptor)</code></a> for information purpose.</li> |
| <li><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"><code>copy(ParameterValueGroup, ParameterValueGroup)</code></a> for copying values into an existing instance.</li> |
| </ul> |
| |
| Most instance methods in this class follow the same naming pattern |
| than the methods provided by the <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"><code>ParameterValue</code></a> interface. |
| Those methods are themselves inspired by JDK methods: |
| |
| <table class="sis"> |
| <caption>Methods fetching parameter value</caption> |
| <tr><th><code>Parameters</code> method</th> <th><code>ParameterValue</code> method</th> <th>JDK methods</th></tr> |
| <tr><td><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#getValue()"><code>getValue()</code></a></td> <td></td></tr> |
| <tr><td><a href="#booleanValue(org.opengis.parameter.ParameterDescriptor)"><code>booleanValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#booleanValue()"><code>booleanValue()</code></a></td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#booleanValue()" title="class or interface in java.lang" class="externalLink"><code>Boolean.booleanValue()</code></a></td></tr> |
| <tr><td><a href="#intValue(org.opengis.parameter.ParameterDescriptor)"><code>intValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#intValue()"><code>intValue()</code></a></td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true#intValue()" title="class or interface in java.lang" class="externalLink"><code>Number.intValue()</code></a></td></tr> |
| <tr><td><a href="#intValueList(org.opengis.parameter.ParameterDescriptor)"><code>intValueList(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#intValueList()"><code>intValueList()</code></a></td> <td></td></tr> |
| <tr><td><a href="#doubleValue(org.opengis.parameter.ParameterDescriptor)"><code>doubleValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#doubleValue()"><code>doubleValue()</code></a></td> <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true#doubleValue()" title="class or interface in java.lang" class="externalLink"><code>Number.doubleValue()</code></a></td></tr> |
| <tr><td><a href="#doubleValueList(org.opengis.parameter.ParameterDescriptor)"><code>doubleValueList(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#doubleValueList()"><code>doubleValueList()</code></a></td> <td></td></tr> |
| <tr><td><a href="#stringValue(org.opengis.parameter.ParameterDescriptor)"><code>stringValue(ParameterDescriptor)</code></a></td> <td><a href="DefaultParameterValue.html#stringValue()"><code>stringValue()</code></a></td> <td></td></tr> |
| </table> |
| |
| |
| <div class="section">Fetching parameter values despite different names, types or units</div> |
| The common way to get a parameter is to invoke the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#parameter(java.lang.String)" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterValueGroup.parameter(String)</code></a> method. |
| This <code>Parameters</code> class provides alternative ways, using a <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"><code>ParameterDescriptor</code></a> argument |
| instead than a <code>String</code> argument. Those descriptors provide additional information like the various |
| <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">aliases</a> under which the same parameter may be known. |
| By using this information, <code>Parameters</code> can choose the most appropriate parameter name or alias |
| (by searching for a common <a href="../referencing/ImmutableIdentifier.html#getAuthority()">authority</a>) |
| when it delegates its work to the <code>parameter(String)</code> method. |
| |
| <div class="note"><b>Example:</b> |
| The same parameter may be known under different names. For example the |
| <a href="../referencing/datum/DefaultEllipsoid.html#getSemiMajorAxis()">length of the semi-major axis of the ellipsoid</a> is commonly known as <code>"semi_major"</code>. |
| But that parameter can also be named <code>"semi_major_axis"</code>, <code>"earth_radius"</code> or simply <code>"a"</code> |
| in other libraries. When fetching parameter values, we do not always know in advance which of the above-cited |
| names is recognized by an arbitrary <code>ParameterValueGroup</code> instance.</div> |
| |
| <code>Parameters</code> uses also the descriptor information for applying type and unit conversions |
| (i.e. returned values are converted to the units of measurement specified by the given parameter descriptor). |
| |
| |
| <div class="section">Note for subclass implementers</div> |
| This class does not implement any method from the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterValueGroup</code></a> interface |
| (this class is not named “<code>AbstractParameterValueGroup</code>” for that reason). |
| Extending this class or extending <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"><code>Object</code></a> make almost no difference for implementers; |
| <code>Parameters</code> purpose is mostly to extend the API for users convenience. |
| All methods in this class get their information from the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterValueGroup</code></a> methods. |
| In addition, unless otherwise specified, methods in this class is isolated from all others: |
| overriding one method has no impact on other methods.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</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"> |
| <!-- ======== 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>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Parameters</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">For subclass constructors only.</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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#booleanValue(org.opengis.parameter.ParameterDescriptor)">booleanValue</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the boolean value of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <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></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cast(org.opengis.parameter.ParameterDescriptor,java.lang.Class)">cast</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><?> descriptor, |
| <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><T> valueClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Casts the given parameter descriptor to the given type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <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><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cast(org.opengis.parameter.ParameterValue,java.lang.Class)">cast</a></span>​(<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><?> parameter, |
| <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><T> valueClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Casts the given parameter value to the given type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrWrap(org.opengis.parameter.ParameterValueGroup)">castOrWrap</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the given parameter value group as a <code>Parameters</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this group of parameter values.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)">copy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> values, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> destination)</code></th> |
| <td class="colLast"> |
| <div class="block">Copies the values of a parameter group into another parameter group.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValue(org.opengis.parameter.ParameterDescriptor)">doubleValue</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><? extends <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">Number</a>> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doubleValueList(org.opengis.parameter.ParameterDescriptor)">doubleValueList</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><double[]> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the floating point values of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <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></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescriptors(org.opengis.parameter.GeneralParameterValue...)">getDescriptors</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a>... parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the descriptors of the given parameters, in the same order.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)">getMandatoryValue</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> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or throws an exception if none.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/MemberName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">MemberName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMemberName(org.opengis.parameter.ParameterDescriptor)">getMemberName</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><?> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the parameter name as an instance of <code>MemberName</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><T> <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><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)">getOrCreate</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> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(org.opengis.parameter.ParameterDescriptor)">getValue</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> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <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(org.opengis.parameter.ParameterDescriptor)">getValueDomain</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><?> descriptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the domain of valid values defined by the given descriptor, or <code>null</code> if none.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intValue(org.opengis.parameter.ParameterDescriptor)">intValue</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><? extends <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">Number</a>> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the integer value of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intValueList(org.opengis.parameter.ParameterDescriptor)">intValueList</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><int[]> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the integer values of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#print()">print</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a string representation of this group to the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang" class="externalLink">standard output stream</a>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stringValue(org.opengis.parameter.ParameterDescriptor)">stringValue</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><? extends <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">CharSequence</a>> parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the string value of the parameter identified by the given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this group.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmodifiable(org.opengis.parameter.ParameterValueGroup)">unmodifiable</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance.</div> |
| </td> |
| </tr> |
| </table> |
| <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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</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.ParameterValueGroup"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#addGroup(java.lang.String)" title="class or interface in org.opengis.parameter" class="externalLink">addGroup</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#getDescriptor()" title="class or interface in org.opengis.parameter" class="externalLink">getDescriptor</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#groups(java.lang.String)" title="class or interface in org.opengis.parameter" class="externalLink">groups</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#parameter(java.lang.String)" title="class or interface in org.opengis.parameter" class="externalLink">parameter</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true#values()" title="class or interface in org.opengis.parameter" class="externalLink">values</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>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Parameters</h4> |
| <pre>protected Parameters()</pre> |
| <div class="block">For subclass constructors only.</div> |
| </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="unmodifiable(org.opengis.parameter.ParameterValueGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmodifiable</h4> |
| <pre class="methodSignature">public static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a> unmodifiable​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> parameters)</pre> |
| <div class="block">Returns the given parameter value group as an unmodifiable <code>Parameters</code> instance. |
| If the given parameters is already an unmodifiable instance of <code>Parameters</code>, |
| then it is returned as-is. Otherwise this method copies all parameter values in a new, |
| unmodifiable, parameter group instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - the parameters to make unmodifiable, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an unmodifiable group with the same parameters than the given group, |
| or <code>null</code> if the given argument was null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#unmodifiable(org.opengis.parameter.ParameterValue)"><code>DefaultParameterValue.unmodifiable(ParameterValue)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="castOrWrap(org.opengis.parameter.ParameterValueGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrWrap</h4> |
| <pre class="methodSignature">public static <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a> castOrWrap​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> parameters)</pre> |
| <div class="block">Returns the given parameter value group as a <code>Parameters</code> instance. |
| If the given parameters is already an instance of <code>Parameters</code>, then it is returned as-is. |
| Otherwise this method returns a wrapper which delegate all method invocations to the given instance. |
| |
| <p>This method provides a way to get access to the non-static <code>Parameters</code> methods, like |
| <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>, for an arbitrary <code>ParameterValueGroup</code> instance.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - the object to cast or wrap, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given argument as an instance of <code>Parameters</code> (may be the same reference), |
| or <code>null</code> if the given argument was null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cast(org.opengis.parameter.ParameterDescriptor,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cast</h4> |
| <pre class="methodSignature">public static <T> <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> cast​(<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><?> descriptor, |
| <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><T> valueClass) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></pre> |
| <div class="block">Casts the given parameter descriptor to the given type. |
| An exception is thrown immediately if the parameter does not have the expected |
| <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the expected value class.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - the descriptor to cast, or <code>null</code>.</dd> |
| <dd><code>valueClass</code> - the expected value class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the descriptor casted to the given value class, or <code>null</code> if the given descriptor was null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the given descriptor does not have the expected value class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#cast(java.lang.Object)" title="class or interface in java.lang" class="externalLink"><code>Class.cast(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cast(org.opengis.parameter.ParameterValue,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cast</h4> |
| <pre class="methodSignature">public static <T> <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><T> cast​(<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><?> parameter, |
| <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><T> valueClass) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></pre> |
| <div class="block">Casts the given parameter value to the given type. |
| An exception is thrown immediately if the parameter does not have the expected value class.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the expected value class.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the parameter to cast, or <code>null</code>.</dd> |
| <dd><code>valueClass</code> - the expected value class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value casted to the given type, or <code>null</code> if the given value was null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the given value doesn't have the expected value class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#cast(java.lang.Object)" title="class or interface in java.lang" class="externalLink"><code>Class.cast(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDescriptors(org.opengis.parameter.GeneralParameterValue...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptors</h4> |
| <pre class="methodSignature">public static <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>[] getDescriptors​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</a>... parameters)</pre> |
| <div class="block">Returns the descriptors of the given parameters, in the same order. |
| Special cases: |
| |
| <ul> |
| <li>If the given array is <code>null</code>, then this method returns <code>null</code>. |
| <li>If an element of the given array is <code>null</code>, then the corresponding |
| element of the returned array is also <code>null</code>.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameters</code> - the parameter values from which to get the descriptors, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the descriptors of the given parameter values, or <code>null</code> if the <code>parameters</code> argument was null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMemberName(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemberName</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/MemberName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">MemberName</a> getMemberName​(<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><?> parameter)</pre> |
| <div class="block">Gets the parameter name as an instance of <code>MemberName</code>. |
| This method performs the following checks: |
| |
| <ul> |
| <li>If the <a href="../referencing/AbstractIdentifiedObject.html#getName()">primary name</a> is an instance of <code>MemberName</code>, |
| returns that primary name.</li> |
| <li>Otherwise this method searches for the first <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> |
| which is an instance of <code>MemberName</code>. If found, that alias is returned.</li> |
| <li>If no alias is found, then this method tries to build a member name from the primary name and the |
| <a href="DefaultParameterDescriptor.html#getValueClass()">value class</a>, using the mapping defined in |
| <a href="../util/iso/DefaultTypeName.html" title="class in org.apache.sis.util.iso"><code>DefaultTypeName</code></a> javadoc.</li> |
| </ul> |
| |
| This method can be used as a bridge between the parameter object |
| defined by ISO 19111 (namely <code>CC_OperationParameter</code>) and the one |
| defined by ISO 19115 (namely <code>SV_Parameter</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the parameter from which to get the name (may be <code>null</code>).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the member name, or <code>null</code> if none.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../util/iso/Names.html#createMemberName(java.lang.CharSequence,java.lang.String,java.lang.CharSequence,java.lang.Class)"><code>Names.createMemberName(CharSequence, String, CharSequence, Class)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValueDomain(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueDomain</h4> |
| <pre class="methodSignature">public static <a href="../measure/Range.html" title="class in org.apache.sis.measure">Range</a><?> getValueDomain​(<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><?> descriptor)</pre> |
| <div class="block">Returns the domain of valid values defined by the given descriptor, or <code>null</code> if none. |
| This method performs the following operations: |
| |
| <ul> |
| <li>If the given parameter is an instance of <code>DefaultParameterDescriptor</code>, |
| delegate to <a href="DefaultParameterDescriptor.html#getValueDomain()"><code>DefaultParameterDescriptor.getValueDomain()</code></a>.</li> |
| <li>Otherwise builds the range from the <a href="DefaultParameterDescriptor.html#getMinimumValue()">minimum value</a>, |
| <a href="DefaultParameterDescriptor.html#getMaximumValue()">maximum value</a> and, if the values are numeric, from |
| the <a href="DefaultParameterDescriptor.html#getUnit()">unit</a>.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - the parameter descriptor, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the domain of valid values, or <code>null</code> if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterDescriptor.html#getValueDomain()"><code>DefaultParameterDescriptor.getValueDomain()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre class="methodSignature">public <T> T getValue​(<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> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or <code>null</code> if none. |
| This method uses the following information from the given <code>parameter</code> descriptor: |
| |
| <ul> |
| <li>The most appropriate <a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> or |
| <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> to use for searching |
| in this <code>ParameterValueGroup</code>, chosen as below: |
| <ul> |
| <li>a name or alias defined by the same |
| <a href="../referencing/ImmutableIdentifier.html#getAuthority()">authority</a>, if any;</li> |
| <li>an arbitrary name or alias otherwise.</li> |
| </ul> |
| </li> |
| <li>The <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> |
| to return if there is no value associated to the above-cited name or alias.</li> |
| <li>The <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a> |
| (if any) of numerical value to return.</li> |
| <li>The <a href="DefaultParameterDescriptor.html#getValueClass()">type</a> of value to return.</li> |
| </ul> |
| |
| This method can be useful when the <code>ParameterDescriptor</code> are known in advance, for example in the |
| implementation of some <a href="../referencing/operation/DefaultOperationMethod.html" title="class in org.apache.sis.referencing.operation">coordinate |
| operation method</a>. If the caller has no such <code>ParameterDescriptor</code> at hand, then the |
| <a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>parameter(String)</code></a> method is probably more convenient.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for, together with the desired type and unit of value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise (which may be <code>null</code>).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="../util/UnconvertibleObjectException.html" title="class in org.apache.sis.util">UnconvertibleObjectException</a></code> - if the parameter value can not be converted to the expected type.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"><code>getMandatoryValue(ParameterDescriptor)</code></a>, |
| <a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)"><code>getOrCreate(ParameterDescriptor)</code></a>, |
| <a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>DefaultParameterValueGroup.parameter(String)</code></a>, |
| <a href="DefaultParameterValue.html#getValue()"><code>DefaultParameterValue.getValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMandatoryValue</h4> |
| <pre class="methodSignature">public <T> T getMandatoryValue​(<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> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the value of the parameter identified by the given descriptor, or throws an exception if none. |
| The default implementation performs the same work than <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> and verifies |
| that the returned value is non-null.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for, together with the desired type and unit of value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise provided that it is not <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>, |
| <a href="#getOrCreate(org.opengis.parameter.ParameterDescriptor)"><code>getOrCreate(ParameterDescriptor)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="booleanValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>booleanValue</h4> |
| <pre class="methodSignature">public boolean booleanValue​(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the boolean value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#booleanValue()"><code>DefaultParameterValue.booleanValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="intValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intValue</h4> |
| <pre class="methodSignature">public int intValue​(<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><? extends <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">Number</a>> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the integer value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#intValue()"><code>DefaultParameterValue.intValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="intValueList(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intValueList</h4> |
| <pre class="methodSignature">public int[] intValueList​(<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><int[]> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the integer values of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter values if they exist, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#intValueList()"><code>DefaultParameterValue.intValueList()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValue</h4> |
| <pre class="methodSignature">public double doubleValue​(<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><? extends <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">Number</a>> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the floating point value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this method |
| uses the given <code>parameter</code> argument. |
| |
| <p>If the given descriptor supplies a <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a>, then the returned value will be converted into that unit.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#doubleValue(javax.measure.Unit)"><code>DefaultParameterValue.doubleValue(Unit)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doubleValueList(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doubleValueList</h4> |
| <pre class="methodSignature">public double[] doubleValueList​(<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><double[]> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the floating point values of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this method |
| uses the given <code>parameter</code> argument. |
| |
| <p>If the given descriptor supplies a <a href="DefaultParameterDescriptor.html#getUnit()">unit of measurement</a>, then the returned values will be converted into that unit.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter values if they exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#doubleValueList(javax.measure.Unit)"><code>DefaultParameterValue.doubleValueList(Unit)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stringValue(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stringValue</h4> |
| <pre class="methodSignature">public <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> stringValue​(<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><? extends <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">CharSequence</a>> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the string value of the parameter identified by the given descriptor. |
| See <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a> for more information about how this |
| method uses the given <code>parameter</code> argument.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the name or alias of the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter value if it exists, or the <strong>non-null</strong> |
| <a href="DefaultParameterDescriptor.html#getDefaultValue()">default value</a> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the value is not defined and there is no default value.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValue.html#stringValue()"><code>DefaultParameterValue.stringValue()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrCreate(org.opengis.parameter.ParameterDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrCreate</h4> |
| <pre class="methodSignature">public <T> <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><T> getOrCreate​(<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> parameter) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></pre> |
| <div class="block">Returns the parameter identified by the given descriptor. |
| If the identified parameter is optional and not yet created, then it will be created now. |
| |
| <p>The default implementation is equivalent to:</p> |
| |
| <blockquote><pre><font color="green">return</font> <b>cast</b>(<b>parameter</b>(name), parameter.<b>getValueClass</b>());</pre></blockquote> |
| |
| where <code>name</code> is a <code>parameter</code> <a href="../referencing/AbstractIdentifiedObject.html#getName()">name</a> |
| or <a href="../referencing/AbstractIdentifiedObject.html#getAlias()">alias</a> chosen by the same algorithm than |
| <a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the parameter value.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parameter</code> - the parameter to look for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the requested parameter instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterNotFoundException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterNotFoundException</a></code> - if the given <code>parameter</code> name or alias is not legal for this group.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getValue(org.opengis.parameter.ParameterDescriptor)"><code>getValue(ParameterDescriptor)</code></a>, |
| <a href="#getMandatoryValue(org.opengis.parameter.ParameterDescriptor)"><code>getMandatoryValue(ParameterDescriptor)</code></a>, |
| <a href="DefaultParameterValueGroup.html#parameter(java.lang.String)"><code>DefaultParameterValueGroup.parameter(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre class="methodSignature">public <a href="Parameters.html" title="class in org.apache.sis.parameter">Parameters</a> clone()</pre> |
| <div class="block">Returns a copy of this group of parameter values. |
| The default implementation performs a <em>shallow</em> copy, |
| but subclasses are encouraged to perform a <em>deep</em> copy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true#clone()" title="class or interface in org.opengis.parameter" class="externalLink">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/GeneralParameterValue.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">GeneralParameterValue</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/ParameterValueGroup.html?is-external=true#clone()" title="class or interface in org.opengis.parameter" class="externalLink">clone</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><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></code> in class <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of this group of parameter values.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"><code>copy(ParameterValueGroup, ParameterValueGroup)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(org.opengis.parameter.ParameterValueGroup,org.opengis.parameter.ParameterValueGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public static void copy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> values, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> destination) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterNameException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterNameException</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></pre> |
| <div class="block">Copies the values of a parameter group into another parameter group. |
| All values in the <code>source</code> group shall be valid for the <code>destination</code> group, |
| but the <code>destination</code> may have more parameters. |
| Sub-groups are copied recursively. |
| |
| <p>A typical usage of this method is for transferring values from an arbitrary implementation |
| to some specific implementation, or to a parameter group using a different but compatible |
| <a href="DefaultParameterValueGroup.html#getDescriptor()">descriptor</a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the parameters values to copy.</dd> |
| <dd><code>destination</code> - where to copy the values.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterNameException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterNameException</a></code> - if a <code>source</code> parameter name is unknown to the <code>destination</code>.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/InvalidParameterValueException.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">InvalidParameterValueException</a></code> - if the value of a <code>source</code> parameter is invalid for the <code>destination</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#clone()"><code>clone()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <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> toString()</pre> |
| <div class="block">Returns a string representation of this group. |
| The default implementation delegates to <a href="ParameterFormat.html" title="class in org.apache.sis.parameter"><code>ParameterFormat</code></a>. |
| |
| <p>This method is for information purpose only and may change in future SIS version.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><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></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="print()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>print</h4> |
| <pre class="methodSignature"><a href="../util/Debug.html" title="annotation in org.apache.sis.util">@Debug</a> |
| public void print()</pre> |
| <div class="block">Prints a string representation of this group to the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang" class="externalLink">standard output stream</a>. |
| If a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Console.html?is-external=true" title="class or interface in java.io" class="externalLink">console</a> is attached to the running JVM (i.e. if the application |
| is run from the command-line and the output is not redirected to a file) and if Apache SIS thinks |
| that the console supports the ANSI escape codes (a.k.a. X3.64), then a syntax coloring will be applied. |
| |
| <p>This is a convenience method for debugging purpose and for console applications.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</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/Parameters.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>Field | </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> |
