| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultParameterDescriptorGroup (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.DefaultParameterDescriptorGroup class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="getInterface()"> |
| <meta name="keywords" content="descriptors()"> |
| <meta name="keywords" content="descriptor()"> |
| <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="DefaultParameterDescriptorGroup (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/DefaultParameterDescriptorGroup.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 DefaultParameterDescriptorGroup" class="title">Class DefaultParameterDescriptorGroup</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>DefaultParameterDescriptorGroup</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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/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/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></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">DefaultParameterDescriptorGroup</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/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></pre> |
| <div class="block">The definition of a group of related parameters used by an operation method. |
| <code>DefaultParameterDescriptorGroup</code> instances are immutable and thus thread-safe. |
| |
| <div class="section">Instantiation</div> |
| Parameter descriptors are usually pre-defined by the SIS library and available through the following methods: |
| |
| <ul> |
| <li><a href="../referencing/operation/DefaultOperationMethod.html#getParameters()"><code>DefaultOperationMethod.getParameters()</code></a></li> |
| </ul> |
| |
| If nevertheless a <code>ParameterDescriptorGroup</code> needs to be instantiated directly, |
| then the <a href="ParameterBuilder.html" title="class in org.apache.sis.parameter"><code>ParameterBuilder</code></a> class may make the task easier. |
| |
| <div class="note"><b>Example:</b> |
| The following example declares the parameters for a <cite>Mercator (variant A)</cite> projection method |
| valid from 80°S to 84°N on all the longitude range (±180°). |
| |
| <blockquote><pre><font color="green">class</font> Mercator { |
| <font color="green">static</font> <font color="green">final</font> ParameterDescriptorGroup PARAMETERS; |
| <font color="green">static</font> { |
| ParameterBuilder builder = <font color="green">new</font> <b>ParameterBuilder</b>(); |
| builder.<b>setCodeSpace</b>(Citations.EPSG, <font color="orangered">"EPSG"</font>).<b>setRequired</b>(<font color="green">true</font>); |
| ParameterDescriptor<?>[] parameters = { |
| builder.<b>addName</b>(<font color="orangered">"Latitude of natural origin"</font>) .<b>createBounded</b>( -80, +84, 0, Units.DEGREE), |
| builder.<b>addName</b>(<font color="orangered">"Longitude of natural origin"</font>) .<b>createBounded</b>(-180, +180, 0, Units.DEGREE), |
| builder.<b>addName</b>(<font color="orangered">"Scale factor at natural origin"</font>).<b>createStrictlyPositive</b>(1, Units.UNITY), |
| builder.<b>addName</b>(<font color="orangered">"False easting"</font>) .<b>create</b>(0, Units.METRE), |
| builder.<b>addName</b>(<font color="orangered">"False northing"</font>) .<b>create</b>(0, Units.METRE) |
| }; |
| builder.<b>addIdentifier</b>(<font color="orangered">"9804"</font>) <i><font color="gray">// Primary key in EPSG database.</font></i> |
| .<b>addName</b>(<font color="orangered">"Mercator (variant A)"</font>) <i><font color="gray">// EPSG name since October 2010.</font></i> |
| .<b>addName</b>(<font color="orangered">"Mercator (1SP)"</font>) <i><font color="gray">// EPSG name prior October 2010.</font></i> |
| .<b>addName</b>(Citations.OGC, <font color="orangered">"Mercator_1SP"</font>); <i><font color="gray">// Name found in some OGC specifications.</font></i> |
| PARAMETERS = builder.<b>createGroup</b>(parameters); |
| } |
| }</pre></blockquote> |
| </div></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter"><code>DefaultParameterValueGroup</code></a>, |
| <a href="DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter"><code>DefaultParameterDescriptor</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.parameter.DefaultParameterDescriptorGroup">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,org.opengis.parameter.GeneralParameterDescriptor...)">DefaultParameterDescriptorGroup</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="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>... parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a parameter group from a set of properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,org.opengis.parameter.ParameterDescriptorGroup)">DefaultParameterDescriptorGroup</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, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a> parameters)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a group with the same parameters than another group.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.parameter.ParameterDescriptorGroup)">DefaultParameterDescriptorGroup</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</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 <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptorGroup</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.parameter.ParameterDescriptorGroup)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS group 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/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</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 instance of <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">parameter value group</a> |
| initialized with the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default values</a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><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></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#descriptor(java.lang.String)">descriptor</a></span>​(<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> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first parameter in this group for the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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="#descriptors()">descriptors</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all parameters in this group.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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 group for equality.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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><? extends <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</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> |
| </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,org.opengis.parameter.GeneralParameterDescriptor...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultParameterDescriptorGroup</h4> |
| <pre>public DefaultParameterDescriptorGroup​(<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="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>... parameters)</pre> |
| <div class="block">Constructs a parameter group from a set of 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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - the properties to be given to the new parameter group.</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>parameters</code> - the <a href="#descriptors()">parameter descriptors</a> for this group.</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 parameter name is duplicated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Map,org.opengis.parameter.ParameterDescriptorGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultParameterDescriptorGroup</h4> |
| <pre>public DefaultParameterDescriptorGroup​(<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, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a> parameters)</pre> |
| <div class="block">Constructs a group with the same parameters than another group. This is a convenience constructor for |
| operations that expect the same parameters than another operation, but perform a different process. |
| |
| <div class="note"><b>Example:</b> |
| the various <cite>"Coordinate Frame Rotation"</cite> variants (EPSG codes 1032, 1038 and 9607) |
| expect the same parameters than their <cite>"Position Vector transformation"</cite> counterpart |
| (EPSG codes 1033, 1037 and 9606) but perform the rotation in the opposite direction.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - the properties to be given to the new parameter group.</dd> |
| <dd><code>parameters</code> - the existing group from which to copy the <a href="#descriptors()">parameter descriptors</a>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.parameter.ParameterDescriptorGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultParameterDescriptorGroup</h4> |
| <pre>protected DefaultParameterDescriptorGroup​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</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.ParameterDescriptorGroup)"><code>castOrCopy(ParameterDescriptorGroup)</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.ParameterDescriptorGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <a href="DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptorGroup</a> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a> object)</pre> |
| <div class="block">Returns a SIS group 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">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/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a>> getInterface()</pre> |
| <div class="block">Returns the GeoAPI interface implemented by this class. |
| The SIS implementation returns <code>ParameterDescriptorGroup.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>ParameterDescriptorGroup</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>ParameterDescriptorGroup.class</code> or a user-defined sub-interface.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="descriptors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptors</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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>> descriptors()</pre> |
| <div class="block">Returns all parameters in this group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true#descriptors()" title="class or interface in org.opengis.parameter" class="externalLink">descriptors</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter descriptors in this group.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="descriptor(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptor</h4> |
| <pre class="methodSignature">public <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> descriptor​(<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> name) |
| 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 first parameter in this group for the specified name. |
| This method does not search in sub-groups.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true#descriptor(java.lang.String)" title="class or interface in org.opengis.parameter" class="externalLink">descriptor</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the parameter to search for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parameter for the given identifier name.</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 there is no parameter for the given name.</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/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a> createValue()</pre> |
| <div class="block">Creates a new instance of <a href="DefaultParameterValueGroup.html" title="class in org.apache.sis.parameter">parameter value group</a> |
| initialized with the <a href="DefaultParameterDescriptor.html#getDefaultValue()">default values</a>. |
| The <a href="DefaultParameterValueGroup.html#getDescriptor()">parameter descriptor</a> for the |
| created group 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/ParameterDescriptorGroup.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/ParameterDescriptorGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterDescriptorGroup</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new parameter instance 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 group for equality.</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/DefaultParameterDescriptorGroup.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> |
