| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>ReferencingByIdentifiers (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.referencing.gazetteer, package: org.apache.sis.referencing.gazetteer, class: ReferencingByIdentifiers"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.referencing.gazetteer.ReferencingByIdentifiers class"> |
| <meta name="keywords" content="THEME_KEY"> |
| <meta name="keywords" content="OVERALL_OWNER_KEY"> |
| <meta name="keywords" content="getTheme()"> |
| <meta name="keywords" content="getOverallOwner()"> |
| <meta name="keywords" content="getLocationTypes()"> |
| <meta name="keywords" content="createCoder()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="computeHashCode()"> |
| <meta name="keywords" content="formatTo()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li><a href="#field-detail">Field</a></li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.referencing.gazetteer</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.referencing.gazetteer</a></div> |
| <h1 title="Class ReferencingByIdentifiers" class="title">Class ReferencingByIdentifiers</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a> |
| <div class="inheritance"><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a> |
| <div class="inheritance"><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a> |
| <div class="inheritance">ReferencingByIdentifiers</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Formattable.html" title="class or interface in java.util" class="external-link">Formattable</a></code>, <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code>, <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html" title="class or interface in org.opengis.referencing" class="external-link">ReferenceSystem</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="GeohashReferenceSystem.html" title="class in org.apache.sis.referencing.gazetteer">GeohashReferenceSystem</a></code>, <code><a href="MilitaryGridReferenceSystem.html" title="class in org.apache.sis.referencing.gazetteer">MilitaryGridReferenceSystem</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ReferencingByIdentifiers</span> |
| <span class="extends-implements">extends <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></span></div> |
| <div class="block">Base class of reference systems that describe locations using geographic identifiers instead of coordinates. |
| |
| <h2 id="immutability-and-thread-safety-heading">Immutability and thread safety</h2> |
| This base class is immutable and thus thread-safe if the property <em>values</em> (not necessarily the map itself) |
| given to the constructor are also immutable. Most SIS subclasses and related classes are immutable under similar |
| conditions. This means that unless otherwise noted in the javadoc, <code>ReferencingByIdentifiers</code> instances |
| created using only SIS factories and static constants can be shared by many objects and passed between threads |
| without synchronization.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer"><code>ModifiableLocationType</code></a></li> |
| <li><a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer"><code>AbstractLocation</code></a></li> |
| <li><a href="../../../../../../serialized-form.html#org.apache.sis.referencing.gazetteer.ReferencingByIdentifiers">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ReferencingByIdentifiers.Coder.html" class="type-name-link" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers.Coder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Conversions between direct positions and identifiers.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OVERALL_OWNER_KEY" class="member-name-link">OVERALL_OWNER_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Key for the <code>"overallOwner"</code> property to be given to the |
| object factory <code>createFoo(…)</code> methods.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#THEME_KEY" class="member-name-link">THEME_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Key for the <code>"theme"</code> property to be given to the |
| object factory <code>createFoo(…)</code> methods.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-AbstractIdentifiedObject">Fields inherited from class <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#DEPRECATED_KEY">DEPRECATED_KEY</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#LOCALE_KEY">LOCALE_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-IdentifiedObject">Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">ALIAS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">IDENTIFIERS_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">NAME_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">REMARKS_KEY</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-ReferenceSystem">Fields inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html" title="class or interface in org.opengis.referencing" class="external-link">ReferenceSystem</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#DOMAIN_OF_VALIDITY_KEY" title="class or interface in org.opengis.referencing" class="external-link">DOMAIN_OF_VALIDITY_KEY</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#SCOPE_KEY" title="class or interface in org.opengis.referencing" class="external-link">SCOPE_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,org.apache.sis.referencing.gazetteer.ModifiableLocationType...)" class="member-name-link">ReferencingByIdentifiers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a>... types)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a reference system from the given properties.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeHashCode()" class="member-name-link">computeHashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked by <code>hashCode()</code> for computing the hash code when first needed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="ReferencingByIdentifiers.Coder.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers.Coder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createCoder()" class="member-name-link">createCoder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a new object performing conversions between <code>DirectPosition</code> and identifiers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object, |
| <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a> mode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares this reference system with the specified object for equality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(org.apache.sis.io.wkt.Formatter)" class="member-name-link">formatTo</a><wbr>(<a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a pseudo-<cite>Well Known Text</cite> (WKT) representation for this object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><? extends <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocationTypes()" class="member-name-link">getLocationTypes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Description of location type(s) in the spatial reference system.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">AbstractParty</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOverallOwner()" class="member-name-link">getOverallOwner</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Authority with overall responsibility for the spatial reference system.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTheme()" class="member-name-link">getTheme</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Property used to characterize the spatial reference system.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractReferenceSystem">Methods inherited from class <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></h3> |
| <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#getDomainOfValidity()">getDomainOfValidity</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#getInterface()">getInterface</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#getScope()">getScope</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-AbstractIdentifiedObject">Methods inherited from class <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></h3> |
| <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#castOrCopy(org.opengis.referencing.IdentifiedObject)">castOrCopy</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#formatTo(java.util.Formatter,int,int,int)">formatTo</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getAlias()">getAlias</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getDescription()">getDescription</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getDomains()">getDomains</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getIdentifiers()">getIdentifiers</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getName()">getName</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getRemarks()">getRemarks</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#hashCode()">hashCode</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#isDeprecated()">isDeprecated</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#isHeuristicMatchForName(java.lang.String)">isHeuristicMatchForName</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-FormattableObject">Methods inherited from class <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3> |
| <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html#print()">print</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html#toString()">toString</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-IdentifiedObject">Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getAlias()" title="class or interface in org.opengis.referencing" class="external-link">getAlias</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getIdentifiers()" title="class or interface in org.opengis.referencing" class="external-link">getIdentifiers</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getName()" title="class or interface in org.opengis.referencing" class="external-link">getName</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#getRemarks()" title="class or interface in org.opengis.referencing" class="external-link">getRemarks</a>, <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#toWKT()" title="class or interface in org.opengis.referencing" class="external-link">toWKT</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="THEME_KEY"> |
| <h3>THEME_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">THEME_KEY</span></div> |
| <div class="block">Key for the <code>"theme"</code> property to be given to the |
| object factory <code>createFoo(…)</code> methods. |
| This is used for setting the value to be returned by <a href="#getTheme()"><code>getTheme()</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getTheme()"><code>getTheme()</code></a></li> |
| <li><a href="../../../../../../constant-values.html#org.apache.sis.referencing.gazetteer.ReferencingByIdentifiers.THEME_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OVERALL_OWNER_KEY"> |
| <h3>OVERALL_OWNER_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">OVERALL_OWNER_KEY</span></div> |
| <div class="block">Key for the <code>"overallOwner"</code> property to be given to the |
| object factory <code>createFoo(…)</code> methods. |
| This is used for setting the value to be returned by <a href="#getOverallOwner()"><code>getOverallOwner()</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="#getOverallOwner()"><code>getOverallOwner()</code></a></li> |
| <li><a href="../../../../../../constant-values.html#org.apache.sis.referencing.gazetteer.ReferencingByIdentifiers.OVERALL_OWNER_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,org.apache.sis.referencing.gazetteer.ModifiableLocationType...)"> |
| <h3>ReferencingByIdentifiers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReferencingByIdentifiers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties, |
| <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a>... types)</span></div> |
| <div class="block">Creates a reference system from the given properties. |
| The properties given in argument follow the same rules than for the |
| <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#%3Cinit%3E(java.util.Map)">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>"theme"</td> |
| <td><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a></td> |
| <td><a href="#getTheme()"><code>getTheme()</code></a></td> |
| </tr> |
| <tr> |
| <td>"overallOwner"</td> |
| <td><code>Party</code></td> |
| <td><a href="#getOverallOwner()"><code>getOverallOwner()</code></a></td> |
| </tr> |
| <tr> |
| <th colspan="3" class="hsep">Defined in parent class (reminder)</th> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#NAME_KEY" title="class or interface in org.opengis.referencing" class="external-link">"name"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Identifier</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getName()"><code>AbstractIdentifiedObject.getName()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"alias"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link"><code>CharSequence</code></a> (optionally as array)</td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getAlias()"><code>AbstractIdentifiedObject.getAlias()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"identifiers"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Identifier.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Identifier</code></a> (optionally as array)</td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getIdentifiers()"><code>AbstractIdentifiedObject.getIdentifiers()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="external-link">"remarks"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#getRemarks()"><code>AbstractIdentifiedObject.getRemarks()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#DOMAIN_OF_VALIDITY_KEY" title="class or interface in org.opengis.referencing" class="external-link">"domainOfValidity"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/Extent.html" title="class or interface in org.opengis.metadata.extent" class="external-link"><code>Extent</code></a></td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#getDomainOfValidity()"><code>AbstractReferenceSystem.getDomainOfValidity()</code></a></td> |
| </tr> |
| <tr> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/ReferenceSystem.html#SCOPE_KEY" title="class or interface in org.opengis.referencing" class="external-link">"scope"</a></td> |
| <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a></td> |
| <td><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html#getScope()"><code>AbstractReferenceSystem.getScope()</code></a></td> |
| </tr> |
| </table> |
| |
| This constructor copies the given <code>LocationType</code> instances as per |
| <code>ModifiableLocationType.snapshot(ReferenceSystemUsingIdentifiers, LocationType...)</code>. |
| Changes in the given location types after construction will not affect this <code>ReferencingByIdentifiers</code>. |
| |
| <div class="warning"><b>Upcoming API change — generalization</b><br> |
| In a future SIS version, the type of array elements may be generalized to the |
| <code>org.opengis.referencing.gazetteer.LocationType</code> interface. |
| This change is pending GeoAPI revision.</div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - the properties to be given to the reference system.</dd> |
| <dd><code>types</code> - description of location type(s) in the spatial reference system.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getTheme()"> |
| <h3>getTheme</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></span> <span class="element-name">getTheme</span>()</div> |
| <div class="block">Property used to characterize the spatial reference system.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>property used to characterize the spatial reference system.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="ModifiableLocationType.html#getTheme()"><code>ModifiableLocationType.getTheme()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOverallOwner()"> |
| <h3>getOverallOwner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">AbstractParty</a></span> <span class="element-name">getOverallOwner</span>()</div> |
| <div class="block">Authority with overall responsibility for the spatial reference system. |
| |
| <div class="warning"><b>Upcoming API change — generalization</b><br> |
| in a future SIS version, the type of returned element may be generalized to the |
| <code>org.opengis.metadata.citation.Party</code> interface. This change is pending |
| GeoAPI revision for upgrade from ISO 19115:2003 to ISO 19115:2014.</div></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>authority with overall responsibility for the spatial reference system.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="ModifiableLocationType.html#getOwner()"><code>ModifiableLocationType.getOwner()</code></a></li> |
| <li><a href="AbstractLocation.html#getAdministrator()"><code>AbstractLocation.getAdministrator()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocationTypes()"> |
| <h3>getLocationTypes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a>></span> <span class="element-name">getLocationTypes</span>()</div> |
| <div class="block">Description of location type(s) in the spatial reference system. |
| The collection returned by this method is unmodifiable. |
| |
| <div class="warning"><b>Upcoming API change — generalization</b><br> |
| in a future SIS version, the type of elements type may be generalized to the |
| <code>org.opengis.referencing.gazetteer.Location</code> interface. |
| This change is pending GeoAPI revision.</div></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>description of location type(s) in the spatial reference system.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="ModifiableLocationType.html#getReferenceSystem()"><code>ModifiableLocationType.getReferenceSystem()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createCoder()"> |
| <h3>createCoder</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="ReferencingByIdentifiers.Coder.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers.Coder</a></span> <span class="element-name">createCoder</span>()</div> |
| <div class="block">Returns a new object performing conversions between <code>DirectPosition</code> and identifiers. |
| The returned object is <strong>not</strong> thread-safe; a new instance must be created |
| for each thread, or synchronization must be applied by the caller.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new object performing conversions between <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/DirectPosition.html" title="class or interface in org.opengis.geometry" class="external-link"><code>DirectPosition</code></a> and identifiers.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object, |
| <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html" title="enum class in org.apache.sis.util">ComparisonMode</a> mode)</span></div> |
| <div class="block">Compares this reference system with the specified object for equality. |
| If the <code>mode</code> argument value is <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html#STRICT"><code>STRICT</code></a> or |
| <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html#BY_CONTRACT"><code>BY_CONTRACT</code></a>, then all available properties are |
| compared including the <a href="#getTheme()">theme</a> and |
| the <a href="#getOverallOwner()">overall owner</a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code> in interface <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></code> in class <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to compare to <code>this</code>.</dd> |
| <dd><code>mode</code> - <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html#STRICT"><code>STRICT</code></a> for performing a strict comparison, or |
| <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/ComparisonMode.html#IGNORE_METADATA"><code>IGNORE_METADATA</code></a> for comparing only |
| properties relevant to location identifications.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if both objects are equal.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#computeHashCode()"><code>AbstractIdentifiedObject.computeHashCode()</code></a></li> |
| <li><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Utilities.html#deepEquals(java.lang.Object,java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>Utilities.deepEquals(Object, Object, ComparisonMode)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeHashCode()"> |
| <h3>computeHashCode</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">computeHashCode</span>()</div> |
| <div class="block">Invoked by <code>hashCode()</code> for computing the hash code when first needed. |
| See <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#computeHashCode()"><code>AbstractIdentifiedObject.computeHashCode()</code></a> |
| for more information.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#computeHashCode()">computeHashCode</a></code> in class <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the hash code value. This value may change in any future Apache SIS version.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(org.apache.sis.io.wkt.Formatter)"> |
| <h3>formatTo</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Debug.html" title="annotation interface in org.apache.sis.util">@Debug</a> |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">formatTo</span><wbr><span class="parameters">(<a href="../../../../../../org.apache.sis.referencing/org/apache/sis/io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a> formatter)</span></div> |
| <div class="block">Formats a pseudo-<cite>Well Known Text</cite> (WKT) representation for this object. |
| The format produced by this method is non-standard and may change in any future Apache SIS version.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></code> in class <code><a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>formatter</code> - the formatter where to format the inner content of this pseudo-WKT element.</dd> |
| <dt>Returns:</dt> |
| <dd>an arbitrary keyword for the pseudo-WKT element.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#21">WKT 2 specification §7</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |