static/apidocs/org/apache/sis/referencing/AbstractIdentifiedObject.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
 <title>AbstractIdentifiedObject (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.referencing.AbstractIdentifiedObject class">
 <meta name="keywords" content="LOCALE_KEY">
 <meta name="keywords" content="DEPRECATED_KEY">
 <meta name="keywords" content="castOrCopy()">
 <meta name="keywords" content="getInterface()">
 <meta name="keywords" content="getName()">
 <meta name="keywords" content="getAlias()">
 <meta name="keywords" content="getIdentifiers()">
 <meta name="keywords" content="getDescription()">
 <meta name="keywords" content="getRemarks()">
 <meta name="keywords" content="isDeprecated()">
 <meta name="keywords" content="isHeuristicMatchForName()">
 <meta name="keywords" content="equals()">
 <meta name="keywords" content="hashCode()">
 <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="../../../../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="AbstractIdentifiedObject (Apache SIS 1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/AbstractIdentifiedObject.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&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.sis.referencing</a></div>
 <h2 title="Class AbstractIdentifiedObject" class="title">Class AbstractIdentifiedObject</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>AbstractIdentifiedObject</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/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a></code></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="operation/AbstractCoordinateOperation.html" title="class in org.apache.sis.referencing.operation">AbstractCoordinateOperation</a></code>, <code><a href="cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">AbstractCS</a></code>, <code><a href="datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">AbstractDatum</a></code>, <code><a href="../parameter/AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></code>, <code><a href="AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></code>, <code><a href="cs/DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">DefaultCoordinateSystemAxis</a></code>, <code><a href="datum/DefaultEllipsoid.html" title="class in org.apache.sis.referencing.datum">DefaultEllipsoid</a></code>, <code><a href="operation/DefaultOperationMethod.html" title="class in org.apache.sis.referencing.operation">DefaultOperationMethod</a></code>, <code><a href="datum/DefaultPrimeMeridian.html" title="class in org.apache.sis.referencing.datum">DefaultPrimeMeridian</a></code></dd>
 </dl>
 <hr>
 <pre>public class <span class="typeNameLabel">AbstractIdentifiedObject</span>
 extends <a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a>
 implements <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>, <a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a>, <a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a>, <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></pre>
 <div class="block">Base class for objects identified by a name or a code. Those objects are typically
  <a href="datum/DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">geodetic datum</a>   (e.g. <cite>"World Geodetic System 1984"</cite>),
  <a href="crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference System</a> (e.g. <cite>"WGS 84 / World Mercator"</cite>) or
  <a href="operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">map projection</a>  (e.g. <cite>"Mercator (variant A)"</cite>).
  Those names, or a code (e.g. <code>"EPSG:3395"</code>), can be used for fetching an object from a database.
  However it is not sufficient to know the object name. We also need to know who define that name
  (the <a href="ImmutableIdentifier.html#getAuthority()">authority</a>) since the same objects are often named differently
  depending on the providers, or conversely the same name is used for different objects depending on the provider.

  <p>The main information stored in an <code>IdentifiedObject</code> are:</p>
  <ul>
    <li>a primary <a href="#getName()">name</a>, considered by the object creator as the preferred name,</li>
    <li>an arbitrary amount of <a href="#getAlias()">aliases</a>, for example a list of names used by other providers,</li>
    <li>an arbitrary amount of <a href="#getIdentifiers()">identifiers</a>, typically primary keys in the provider database,</li>
    <li>optional <a href="#getRemarks()">remarks</a>.</li>
  </ul>

  <div class="section">Instantiation</div>
  This class is conceptually <cite>abstract</cite>, even if it is technically possible to instantiate it.
  Applications should instead instantiate the most specific subclass having a name starting by <code>Default</code>.
  However exceptions to this rule may occur when it is not possible to identify the exact type.

  <div class="note"><b>Example:</b>
  It is sometime not possible to infer the exact coordinate system type from
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/doc-files/WKT.html">version 1
  of <cite>Well Known Text format</cite></a>, for example when parsing a <code>LOCAL_CS</code> element.
  In such exceptional situation, a plain <code>AbstractCS</code> object may be instantiated.</div>

  <code>IdentifiedObject</code> instances are created in two main ways:

  <ul>
    <li>Using an <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ObjectFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ObjectFactory</code></a>, in which case all properties can be explicitly specified.</li>
    <li>Using an <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/AuthorityFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>AuthorityFactory</code></a>, in which case only a code (typically a primary key) is specified.
        The <a href="ImmutableIdentifier.html#getAuthority()">authority</a>
        and <a href="ImmutableIdentifier.html#getCode()">authority code</a> values are set to the authority name
        of the factory object, and the authority code supplied by the client, respectively.
        All other information are fetched from the database.</li>
  </ul>

  <div class="section">Immutability and thread safety</div>
  This base class is immutable if the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink"><code>Citation</code></a>, <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>, <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> and
  <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> instances 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>IdentifiedObject</code> instances created using only SIS factories and static constants can be shared by many
  objects and passed between threads without synchronization.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.4</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../serialized-form.html#org.apache.sis.referencing.AbstractIdentifiedObject">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>
 <table class="memberSummary">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Field</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEPRECATED_KEY">DEPRECATED_KEY</a></span></code></th>
 <td class="colLast">
 <div class="block">Optional key which can be given to the <a href="#%3Cinit%3E(java.util.Map)">constructor</a>
  for specifying the object is deprecated.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOCALE_KEY">LOCALE_KEY</a></span></code></th>
 <td class="colLast">
 <div class="block">Optional key which can be given to the <a href="#%3Cinit%3E(java.util.Map)">constructor</a> for specifying
  the locale to use for producing error messages.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.IdentifiedObject">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;<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">&nbsp;</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>&nbsp;</code></td>
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map)">AbstractIdentifiedObject</a></span>&#8203;(<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>&lt;<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>,&#8203;?&gt;&nbsp;properties)</code></th>
 <td class="colLast">
 <div class="block">Constructs an object from the given properties.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected </code></td>
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.IdentifiedObject)">AbstractIdentifiedObject</a></span>&#8203;(<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>&nbsp;object)</code></th>
 <td class="colLast">
 <div class="block">Constructs a new identified object 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.referencing.IdentifiedObject)">castOrCopy</a></span>&#8203;(<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>&nbsp;object)</code></th>
 <td class="colLast">
 <div class="block">Returns a SIS identified object implementation with the values of 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="#hashCode()"><code>hashCode()</code></a> for computing the hash code when first needed.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<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>&nbsp;object)</code></th>
 <td class="colLast">
 <div class="block">Compares the specified object with this object for equality.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a></span>&#8203;(<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>&nbsp;object,
       <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</code></th>
 <td class="colLast">
 <div class="block">Compares this object with the given object for equality.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></span>&#8203;(<a href="../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a>&nbsp;formatter)</code></th>
 <td class="colLast">
 <div class="block">Formats the inner part of the <cite>Well Known Text</cite> (WKT) representation for this object.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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">GenericName</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAlias()">getAlias</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns alternative names by which this object is identified.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><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">InternationalString</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescription()">getDescription</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a narrative explanation of the role of this object.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<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">ReferenceIdentifier</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentifiers()">getIdentifiers</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns identifiers which references elsewhere the object's defining information.</div>
 </td>
 </tr>
 <tr id="i8" 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>&lt;? extends <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>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterface()">getInterface</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the GeoAPI interface implemented by this class.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code><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">ReferenceIdentifier</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the primary name by which this object is identified.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code><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">InternationalString</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemarks()">getRemarks</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns comments on or information about this object, including data source information.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a hash value for this identified object.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDeprecated()">isDeprecated</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns <code>true</code> if this object is deprecated.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isHeuristicMatchForName(java.lang.String)">isHeuristicMatchForName</a></span>&#8203;(<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>&nbsp;name)</code></th>
 <td class="colLast">
 <div class="block">Returns <code>true</code> if either the <a href="#getName()">primary name</a> or at least
  one <a href="#getAlias()">alias</a> matches the given string according heuristic rules.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.FormattableObject">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3>
 <code><a href="../io/wkt/FormattableObject.html#print()">print</a>, <a href="../io/wkt/FormattableObject.html#toString()">toString</a>, <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&nbsp;<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.IdentifiedObject">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;<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#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">
 <!-- ============ FIELD DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a id="LOCALE_KEY">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>LOCALE_KEY</h4>
 <pre>public static final&nbsp;<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> LOCALE_KEY</pre>
 <div class="block">Optional key which can be given to the <a href="#%3Cinit%3E(java.util.Map)">constructor</a> for specifying
  the locale to use for producing error messages. Notes:

  <ul>
    <li>The locale is not stored in any <code>AbstractIdentifiedObject</code> property;
        its value is ignored if no error occurred at construction time.</li>
    <li>The locale is used on a <cite>best effort</cite> basis;
        not all error messages may be localized.</li>
  </ul></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.sis.referencing.AbstractIdentifiedObject.LOCALE_KEY">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a id="DEPRECATED_KEY">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>DEPRECATED_KEY</h4>
 <pre>public static final&nbsp;<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> DEPRECATED_KEY</pre>
 <div class="block">Optional key which can be given to the <a href="#%3Cinit%3E(java.util.Map)">constructor</a>
  for specifying the object is deprecated. If deprecated, then the replacement should be specified
  in the <a href="#getRemarks()">remarks</a>.

  <div class="note"><b>Example:</b> "superseded by code XYZ".</div></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.6</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.sis.referencing.AbstractIdentifiedObject.DEPRECATED_KEY">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;(java.util.Map)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>AbstractIdentifiedObject</h4>
 <pre>public&nbsp;AbstractIdentifiedObject&#8203;(<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>&lt;<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>,&#8203;?&gt;&nbsp;properties)
                          throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre>
 <div class="block">Constructs an object from the given properties. Keys are strings from the table below.
  The map given in argument shall contain an entry at least for the
  <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> or
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#CODE_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"code"</a> key.
  Other properties listed in the table below are optional.
  In particular, <code>"authority"</code>, <code>"code"</code>, <code>"codespace"</code> and <code>"version"</code>
  are convenience properties for building a name, and are ignored if the <code>"name"</code> property
  is already a <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> object instead than a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a>.

  <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="#getName()"><code>getName()</code></a></td>
    </tr>
    <tr>
      <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#AUTHORITY_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"authority"</a></td>
      <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink"><code>Citation</code></a></td>
      <td><a href="ImmutableIdentifier.html#getAuthority()"><code>ImmutableIdentifier.getAuthority()</code></a> on the <a href="#getName()">name</a></td>
    </tr>
    <tr>
      <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true#CODE_KEY" title="class or interface in org.opengis.metadata" class="externalLink">"code"</a></td>
      <td><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="ImmutableIdentifier.html#getCode()"><code>ImmutableIdentifier.getCode()</code></a> on the <a href="#getName()">name</a></td>
    </tr>
    <tr>
      <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true#CODESPACE_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"codespace"</a></td>
      <td><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="ImmutableIdentifier.html#getCodeSpace()"><code>ImmutableIdentifier.getCodeSpace()</code></a> on the <a href="#getName()">name</a></td>
    </tr>
    <tr>
      <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true#VERSION_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"version"</a></td>
      <td><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="ImmutableIdentifier.html#getVersion()"><code>ImmutableIdentifier.getVersion()</code></a> on the <a href="#getName()">name</a></td>
    </tr>
    <tr>
      <td>"description"</td>
      <td><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="ImmutableIdentifier.html#getDescription()"><code>ImmutableIdentifier.getDescription()</code></a> on the <a href="#getName()">name</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="#getAlias()"><code>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="#getIdentifiers()"><code>getIdentifiers()</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="#getRemarks()"><code>getRemarks()</code></a></td>
    </tr>
    <tr>
      <td><a href="#DEPRECATED_KEY">"deprecated"</a></td>
      <td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a></td>
      <td><a href="#isDeprecated()"><code>isDeprecated()</code></a></td>
    </tr>
    <tr>
      <td><a href="#LOCALE_KEY">"locale"</a></td>
      <td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Locale</code></a></td>
      <td>(none)</td>
    </tr>
  </table>

  <div class="section">Localization</div>
  All localizable attributes like <code>"remarks"</code> may have a language and country code suffix.
  For example the <code>"remarks_fr"</code> property stands for remarks in <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true#FRENCH" title="class or interface in java.util" class="externalLink">French</a> and
  the <code>"remarks_fr_CA"</code> property stands for remarks in <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true#CANADA_FRENCH" title="class or interface in java.util" class="externalLink">French Canadian</a>.
  They are convenience properties for building the <code>InternationalString</code> value.

  <p>The <code>"locale"</code> property applies only in case of exception for formatting the error message, and
  is used only on a <cite>best effort</cite> basis. The locale is discarded after successful construction
  since localizations are applied by the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true#toString(java.util.Locale)" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString.toString(Locale)</code></a> method.</p>

  <div class="section">Properties map versus explicit arguments</div>
  Generally speaking, information provided in the <code>properties</code> map are considered ignorable metadata
  while information provided in explicit arguments to the sub-class constructors have an impact on coordinate
  transformation results. See <a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>equals(Object, ComparisonMode)</code></a> for more information.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>properties</code> - the properties to be given to this identified object.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if a property has an invalid value.</dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(org.opengis.referencing.IdentifiedObject)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AbstractIdentifiedObject</h4>
 <pre>protected&nbsp;AbstractIdentifiedObject&#8203;(<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>&nbsp;object)</pre>
 <div class="block">Constructs a new identified object 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>object</code> - the object to shallow copy.</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.referencing.IdentifiedObject)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>castOrCopy</h4>
 <pre class="methodSignature">public static&nbsp;<a href="AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a>&nbsp;castOrCopy&#8203;(<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>&nbsp;object)</pre>
 <div class="block">Returns a SIS identified object implementation with the values of the given arbitrary implementation.
  This method performs the first applicable action in the following choices:

  <ul>
    <li>If the given object is <code>null</code>, then this method returns <code>null</code>.</li>
    <li>Otherwise if the given object is an instance of
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink"><code>CoordinateReferenceSystem</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystem.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>CoordinateSystem</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>CoordinateSystemAxis</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Datum.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Datum</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/Ellipsoid.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>Ellipsoid</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/datum/PrimeMeridian.html?is-external=true" title="class or interface in org.opengis.referencing.datum" class="externalLink"><code>PrimeMeridian</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/OperationMethod.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>OperationMethod</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>CoordinateOperation</code></a>,
        <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/parameter/ParameterDescriptor.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink"><code>ParameterDescriptor</code></a> or
        <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"><code>ParameterDescriptorGroup</code></a>,
        then this method delegates to the <code>castOrCopy(…)</code> method of the corresponding SIS subclass.
        Note that if the given object implements more than one of the above-cited interfaces,
        then the <code>castOrCopy(…)</code> method to be used is unspecified.</li>
    <li>Otherwise if the given object is already an instance of
        <code>AbstractIdentifiedObject</code>, then it is returned unchanged.</li>
    <li>Otherwise a new <code>AbstractIdentifiedObject</code> instance is created using the
        <a href="#%3Cinit%3E(org.opengis.referencing.IdentifiedObject)">copy constructor</a>
        and returned. Note that this is a <cite>shallow</cite> copy operation, since the other
        properties contained in the given object are not recursively copied.</li>
  </ul></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&nbsp;<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>&lt;? extends <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>&gt;&nbsp;getInterface()</pre>
 <div class="block">Returns the GeoAPI interface implemented by this class.
  This information is part of the data compared by <a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>equals(Object, ComparisonMode)</code></a>.

  <p>The default implementation returns <code>IdentifiedObject.class</code>.
  Subclasses implementing a more specific GeoAPI interface shall override this method.</p>

  <div class="section">Invariants</div>
  The following invariants must hold for all <code>AbstractIdentifiedObject</code> instances:
  <ul>
    <li><code>getInterface().<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#isInstance(java.lang.Object)" title="class or interface in java.lang" class="externalLink">isInstance</a>(this)</code>
        shall return <code>true</code>.</li>
    <li>If <code>A.getClass() == B.getClass()</code> is <code>true</code>, then
        <code>A.getInterface() == B.getInterface()</code> shall be <code>true</code>.
        Note that the converse does not need to hold.</li>
  </ul></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the GeoAPI interface implemented by this class.</dd>
 </dl>
 </li>
 </ul>
 <a id="getName()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getName</h4>
 <pre class="methodSignature">public&nbsp;<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">ReferenceIdentifier</a>&nbsp;getName()</pre>
 <div class="block">Returns the primary name by which this object is identified.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><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></code>&nbsp;in interface&nbsp;<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>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the primary name.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="IdentifiedObjects.html#getName(org.opengis.referencing.IdentifiedObject,org.opengis.metadata.citation.Citation)"><code>IdentifiedObjects.getName(IdentifiedObject, Citation)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getAlias()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAlias</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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">GenericName</a>&gt;&nbsp;getAlias()</pre>
 <div class="block">Returns alternative names by which this object is identified.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><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></code>&nbsp;in interface&nbsp;<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>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the aliases, or an empty collection if there is none.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="#getName()"><code>getName()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getIdentifiers()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getIdentifiers</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<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">ReferenceIdentifier</a>&gt;&nbsp;getIdentifiers()</pre>
 <div class="block">Returns identifiers which references elsewhere the object's defining information.
  Alternatively identifiers by which this object can be referenced.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><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></code>&nbsp;in interface&nbsp;<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>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this object identifiers, or an empty set if there is none.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="IdentifiedObjects.html#getIdentifier(org.opengis.referencing.IdentifiedObject,org.opengis.metadata.citation.Citation)"><code>IdentifiedObjects.getIdentifier(IdentifiedObject, Citation)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getDescription()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getDescription</h4>
 <pre class="methodSignature">public&nbsp;<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">InternationalString</a>&nbsp;getDescription()</pre>
 <div class="block">Returns a narrative explanation of the role of this object.

  <div class="section">Default value</div>
  The default implementation returns the <a href="ImmutableIdentifier.html#getDescription()">description</a>
  provided by this object's <a href="#getName()">name</a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a narrative explanation of the role of this object, or <code>null</code> if none.</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.6</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="ImmutableIdentifier.html#getDescription()"><code>ImmutableIdentifier.getDescription()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getRemarks()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRemarks</h4>
 <pre class="methodSignature">public&nbsp;<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">InternationalString</a>&nbsp;getRemarks()</pre>
 <div class="block">Returns comments on or information about this object, including data source information.
  If this object <a href="#isDeprecated()">is deprecated</a>, then the remarks should give
  indication about the replacement (e.g. <cite>"superceded by …"</cite>).</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../util/Deprecable.html#getRemarks()">getRemarks</a></code>&nbsp;in interface&nbsp;<code><a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><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></code>&nbsp;in interface&nbsp;<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>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the remarks, or <code>null</code> if none.</dd>
 </dl>
 </li>
 </ul>
 <a id="isDeprecated()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isDeprecated</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isDeprecated()</pre>
 <div class="block">Returns <code>true</code> if this object is deprecated. Deprecated objects exist in some
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/AuthorityFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">authority factories</a> like the EPSG database.
  If this method returns <code>true</code>, then the <a href="#getRemarks()">remarks</a> should give
  indication about the replacement (e.g. <cite>"superceded by …"</cite>).</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../util/Deprecable.html#isDeprecated()">isDeprecated</a></code>&nbsp;in interface&nbsp;<code><a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if this object is deprecated.</dd>
 </dl>
 </li>
 </ul>
 <a id="isHeuristicMatchForName(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isHeuristicMatchForName</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isHeuristicMatchForName&#8203;(<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>&nbsp;name)</pre>
 <div class="block">Returns <code>true</code> if either the <a href="#getName()">primary name</a> or at least
  one <a href="#getAlias()">alias</a> matches the given string according heuristic rules.
  The default implementation returns <code>true</code> if the given <code>name</code> is equal,
  ignoring aspects documented below, to one of the following names:

  <ul>
    <li>The <a href="#getName()">primary name</a>'s <a href="ImmutableIdentifier.html#getCode()">code</a>
        (without <a href="ImmutableIdentifier.html#getCodeSpace()">codespace</a>).</li>
    <li>Any <a href="#getAlias()">alias</a>'s <a href="NamedIdentifier.html#tip()">tip</a>
        (without <a href="NamedIdentifier.html#scope()">scope</a> and namespace).</li>
  </ul>

  The comparison ignores the following aspects:
  <ul>
    <li>Lower/upper cases.</li>
    <li>Some Latin diacritical signs (e.g. <code>"Réunion"</code> and <code>"Reunion"</code> are considered equal).</li>
    <li>All characters that are not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true#isLetterOrDigit(int)" title="class or interface in java.lang" class="externalLink">letters or digits</a>
        (e.g. <code>"Mercator (1SP)"</code> and <code>"Mercator_1SP"</code> are considered equal).</li>
    <li>Namespaces or scopes, because this method is typically invoked with either the value of an other
        <code>IdentifiedObject.getName().getCode()</code> or with the <cite>Well Known Text</cite> (WKT)
        projection or parameter name.</li>
  </ul>

  <div class="section">Usage</div>
  This method is invoked by SIS when comparing in <a href="../util/ComparisonMode.html#IGNORE_METADATA"><code>IGNORE_METADATA</code></a> mode
  two objects that can be differentiated only by some identifier (name or alias), like
  <a href="cs/DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">coordinate system axes</a>,
  <a href="datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">datum</a>,
  <a href="../parameter/DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">parameters</a> and
  <a href="operation/DefaultOperationMethod.html" title="class in org.apache.sis.referencing.operation">operation methods</a>.
  See <a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>equals(Object, ComparisonMode)</code></a> for more information.

  <p>This method is also invoked when searching a parameter or operation method for a given name.
  For example the same projection is known as <code>"Mercator (variant A)"</code> (the primary name according EPSG)
  and <code>"Mercator (1SP)"</code> (the legacy name prior EPSG 7.6). Since the later is still in frequent use, SIS
  accepts it as an alias of the <cite>Mercator (variant A)</cite> projection.</p>

  <div class="section">Overriding by subclasses</div>
  Some subclasses add more flexibility to the comparisons:
  <ul>
    <li><a href="cs/DefaultCoordinateSystemAxis.html#isHeuristicMatchForName(java.lang.String)">Comparisons of coordinate system axis names</a> consider <code>"Lat"</code>, <code>"Latitude"</code> and
        <code>"Geodetic latitude"</code> as synonymous, and likewise for longitude.</li>
    <li><a href="datum/AbstractDatum.html#isHeuristicMatchForName(java.lang.String)">Comparisons of datum names</a> ignore the <code>"D_"</code> prefix, if any.
        This prefix appears in ESRI datum name (e.g. <code>"D_WGS_1984"</code>).</li>
    <li><a href="datum/DefaultGeodeticDatum.html#isHeuristicMatchForName(java.lang.String)">Comparisons of geodetic datum names</a> may ignore the prime meridian name, if any.
        Example: <cite>"(Paris)"</cite> in <cite>"Nouvelle Triangulation Française (Paris)"</cite>.</li>
  </ul>

  <div class="section">Future evolutions</div>
  This method implements recommendations from the
  <a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#139">WKT 2 specification §B.5.2</a>,
  together with heuristic rules learned from experience while trying to provide inter-operability
  with different data producers. Those rules may be adjusted in any future SIS version according experience
  gained while working with more data producers.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name to compare with the object name or aliases.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the primary name or at least one alias matches the specified <code>name</code>.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="IdentifiedObjects.html#isHeuristicMatchForName(org.opengis.referencing.IdentifiedObject,java.lang.String)"><code>IdentifiedObjects.isHeuristicMatchForName(IdentifiedObject, String)</code></a>,
 <a href="../util/Characters.Filter.html#LETTERS_AND_DIGITS"><code>Characters.Filter.LETTERS_AND_DIGITS</code></a></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&nbsp;boolean&nbsp;equals&#8203;(<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>&nbsp;object,
                       <a href="../util/ComparisonMode.html" title="enum in org.apache.sis.util">ComparisonMode</a>&nbsp;mode)</pre>
 <div class="block">Compares this object with the given object for equality.
  The strictness level is controlled by the second argument,
  from stricter to more permissive values:

  <table class="sis">
    <caption>Description of comparison modes</caption>
    <tr><th>Mode</th><th>Description</th></tr>
    <tr><td><a href="../util/ComparisonMode.html#STRICT"><code>STRICT</code></a>:</td>
         <td>Verifies if the two objects are of the same <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">class</a>
             and compares all public properties, including SIS-specific (non standard) properties.</td></tr>
    <tr><td><a href="../util/ComparisonMode.html#BY_CONTRACT"><code>BY_CONTRACT</code></a>:</td>
        <td>Verifies if the two objects implement the same <a href="#getInterface()">GeoAPI interface</a>
            and compares all properties defined by that interface (<a href="#getName()">name</a>,
            <a href="#getIdentifiers()">identifiers</a>, <a href="#getRemarks()">remarks</a>, <i>etc</i>).
            The two objects do not need to be instances of the same implementation class
            and SIS-specific properties are ignored.</td></tr>
    <tr><td><a href="../util/ComparisonMode.html#IGNORE_METADATA"><code>IGNORE_METADATA</code></a>:</td>
        <td>Compares only the properties relevant to coordinate transformations. Generally speaking, the content
            of the <code>properties</code> map given at <a href="#%3Cinit%3E(java.util.Map)">construction time</a>
            is considered ignorable metadata while the explicit arguments given to the constructor (if any) are
            considered non-ignorable. Note that there is some exceptions to this rule of thumb — see
            <cite>When object name matter</cite> below.</td></tr>
    <tr><td><a href="../util/ComparisonMode.html#APPROXIMATE"><code>APPROXIMATE</code></a>:</td>
        <td>Same as <code>IGNORE_METADATA</code>, with some tolerance threshold on numerical values.</td></tr>
    <tr><td><a href="../util/ComparisonMode.html#ALLOW_VARIANT"><code>ALLOW_VARIANT</code></a>:</td>
        <td>Same as <code>APPROXIMATE</code>, but ignores coordinate system axes.</td></tr>
    <tr><td><a href="../util/ComparisonMode.html#DEBUG"><code>DEBUG</code></a>:</td>
         <td>Special mode for figuring out why two objects expected to be equal are not.</td></tr>
  </table>

  The main guideline is that if <code>sourceCRS.equals(targetCRS, IGNORE_METADATA)</code> returns <code>true</code>,
  then the transformation from <code>sourceCRS</code> to <code>targetCRS</code> should be the identity transform
  even if the two CRS do not have the same name.

  <div class="section">When object name matter</div>
  Some subclasses (especially
  <a href="cs/DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs"><code>DefaultCoordinateSystemAxis</code></a>,
  <a href="datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum"><code>AbstractDatum</code></a> and
  <a href="../parameter/DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter"><code>DefaultParameterDescriptor</code></a>) will compare the
  <a href="#getName()">name</a> even in <code>IGNORE_METADATA</code> mode,
  because objects of those types with different names have completely different meaning.
  For example nothing differentiate the <code>"semi_major"</code> and <code>"semi_minor"</code> parameters except the name.
  The name comparison may be lenient however, i.e. the rules may accept a name matching an alias.
  See <a href="#isHeuristicMatchForName(java.lang.String)"><code>isHeuristicMatchForName(String)</code></a> for more information.

  <div class="section">Conformance to the <code>equals(Object)</code> method contract</div>
  <a href="../util/ComparisonMode.html#STRICT"><code>ComparisonMode.STRICT</code></a> is the only mode compliant with the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink"><code>Object.equals(Object)</code></a> contract.
  For all other modes, the comparison is not guaranteed to be <cite>symmetric</cite> neither
  <cite>transitive</cite>. See <a href="../util/LenientComparable.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>LenientComparable</code></a>
  for more information.</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>&nbsp;in interface&nbsp;<code><a href="../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</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="#computeHashCode()"><code>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="equals(java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>equals</h4>
 <pre class="methodSignature">public final&nbsp;boolean&nbsp;equals&#8203;(<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>&nbsp;object)</pre>
 <div class="block">Compares the specified object with this object for equality.
  This method is implemented as below (omitting assertions):

  <blockquote><pre><font color="green">return</font> <b>equals</b>(other, ComparisonMode.STRICT);</pre></blockquote>

  Subclasses shall override <a href="#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)"><code>equals(Object, ComparisonMode)</code></a> instead than this method.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../util/LenientComparable.html#equals(java.lang.Object)">equals</a></code>&nbsp;in interface&nbsp;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>object</code> - the other object (may be <code>null</code>).</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if both objects are equal.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../util/ComparisonMode.html#STRICT"><code>ComparisonMode.STRICT</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="hashCode()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hashCode</h4>
 <pre class="methodSignature">public final&nbsp;int&nbsp;hashCode()</pre>
 <div class="block">Returns a hash value for this identified object. Two <code>AbstractIdentifiedObject</code> instances
  for which <a href="#equals(java.lang.Object)"><code>equals(Object)</code></a> returns <code>true</code> shall have the same hash code value, if
  the hash codes are computed on the same JVM instance for both objects. The hash code value is
  <em>not</em> guaranteed to be stable between different versions of the Apache SIS library, or
  between libraries running on different JVM.

  <div class="section">Implementation note</div>
  This method invokes <a href="#computeHashCode()"><code>computeHashCode()</code></a> when first needed, then caches the result.
  Subclasses shall override <a href="#computeHashCode()"><code>computeHashCode()</code></a> instead than this method.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the hash code value. This value may change in any future Apache SIS version.</dd>
 </dl>
 </li>
 </ul>
 <a id="computeHashCode()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>computeHashCode</h4>
 <pre class="methodSignature">protected&nbsp;long&nbsp;computeHashCode()</pre>
 <div class="block">Invoked by <a href="#hashCode()"><code>hashCode()</code></a> for computing the hash code when first needed.
  This method is invoked at most once in normal execution, or an arbitrary amount of times if Java
  assertions are enabled. The hash code value shall never change during the whole lifetime of this
  object in a JVM. The hash code value does not need to be the same in two different executions of
  the JVM.

  <div class="section">Overriding</div>
  Subclasses can override this method for using more properties in hash code calculation.
  All <code>computeHashCode()</code> methods shall invoke <code>super.computeHashCode()</code>,
  <strong>not</strong> <code>hashCode()</code>. Example:

  <blockquote><pre>@Override
 <font color="green">protected</font> <font color="green">long</font> <b>computeHashCode</b>() {
     <font color="green">return</font> <font color="green">super</font>.<b>computeHashCode</b>() + 31 * Objects.<b>hash</b>(myProperties);
 }</pre></blockquote></div>
 <dl>
 <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>
 <a id="formatTo(org.apache.sis.io.wkt.Formatter)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>formatTo</h4>
 <pre class="methodSignature">protected&nbsp;<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>&nbsp;formatTo&#8203;(<a href="../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a>&nbsp;formatter)</pre>
 <div class="block">Formats the inner part of the <cite>Well Known Text</cite> (WKT) representation for this object.
  The default implementation writes the following elements:

  <ul>
    <li>The object <a href="#getName()">name</a>.</li>
  </ul>

  Keywords and metadata (scope, extent, identifier and remarks) shall not be formatted here.
  For example if this formattable element is for a <code>GeodeticCRS[…]</code> element,
  then subclasses shall write the content starting at the insertion point shown below:

  <div class="horizontal-flow">
  <div><p><b>WKT example</b></p>
  <blockquote><pre>GeodeticCRS["WGS 84", ID["EPSG", 4326]]
                     ↑
             (insertion point)</pre></blockquote>
  </div><div>
  <p><b>Java code example</b></p>
  <blockquote><pre><font color="green">super</font>.<b>formatTo</b>(formatter);
 <i><font color="gray">// ... write the elements at the insertion point ...</font></i>
 <font color="green">return</font> <font color="orangered">"GeodeticCRS"</font>;</pre></blockquote>
  </div></div>

  <div class="section">Formatting non-standard WKT</div>
  If the implementation can not represent this object without violating some WKT constraints,
  it can uses its own (non-standard) keywords but shall declare that it did so by invoking one
  of the <a href="../io/wkt/Formatter.html#setInvalidWKT(org.opengis.referencing.IdentifiedObject,java.lang.Exception)"><code>Formatter.setInvalidWKT(…)</code></a>
  methods.

  <p>Alternatively, the implementation may also have no WKT keyword for this object.
  In such case, this method shall return <code>null</code>.</p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../io/wkt/FormattableObject.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a></code>&nbsp;in class&nbsp;<code><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>formatter</code> - the formatter where to format the inner content of this WKT element.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <a href="../io/wkt/KeywordCase.html#CAMEL_CASE">CamelCase</a> keyword
          for the WKT element, or <code>null</code> if unknown.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#21">WKT 2 specification §7</a></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/AbstractIdentifiedObject.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&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>