blob: c5f8dbeea1bc4250de64045d0347013380a6622c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>AbstractLocation (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: AbstractLocation">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.referencing.gazetteer.AbstractLocation class">
<meta name="keywords" content="getGeographicIdentifier()">
<meta name="keywords" content="getAlternativeGeographicIdentifiers()">
<meta name="keywords" content="getTemporalExtent()">
<meta name="keywords" content="getGeographicExtent()">
<meta name="keywords" content="getEnvelope()">
<meta name="keywords" content="getPosition()">
<meta name="keywords" content="getLocationType()">
<meta name="keywords" content="getAdministrator()">
<meta name="keywords" content="getParents()">
<meta name="keywords" content="getChildren()">
<meta name="keywords" content="toString()">
<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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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>Nested</li>
<li>Field</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>Field</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="../../../../../module-summary.html">org.apache.sis.referencing.gazetteer</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.referencing.gazetteer</a></div>
<h1 title="Class AbstractLocation" class="title">Class AbstractLocation</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">AbstractLocation</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractLocation</span>
<span class="extends-implements">extends <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></span></div>
<div class="block">Identifiable geographic place. A geographic place may be identified by a name (for example “Eiffel Tower”),
by a postcode, or any other method specified by the <a href="ModifiableLocationType.html#getIdentifications()">location type identifications</a>.
<p>ISO 19112 describes the following properties as mandatory, but Apache SIS relaxes this restriction by
providing default values (possibly <code>null</code>) in most cases:</p>
<ul>
<li><b>geographic identifier</b> (the value, for example a name or code)</li>
<li><b>geographic extent</b> (the position of the identified thing)</li>
<li><b>administrator</b> (who is responsible for this identifier)</li>
<li><b>location type</b> (which specifies the nature of the identifier and its associated geographic location)</li>
</ul>
The following properties are optional:
<ul>
<li><b>temporal extent</b></li>
<li><b>alternative geographic identifier</b></li>
<li><b>envelope</b> (an Apache SIS extension not in ISO 19112 standard)</li>
<li><b>position</b> (mandatory if the geographic identifier contains insufficient information to identify location)</li>
<li><b>parent location instance</b></li>
<li><b>child location instance</b></li>
</ul></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>Modifiable­Location­Type</code></a></li>
<li><a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer"><code>Referencing­By­Identifiers</code></a></li>
<li><a href="LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer"><code>Location­Format</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.referencing.gazetteer.ModifiableLocationType,java.lang.CharSequence)" class="member-name-link">Abstract­Location</a><wbr>(<a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">Modifiable­Location­Type</a>&nbsp;type,
<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">Char­Sequence</a>&nbsp;identifier)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new location for the given geographic identifier.</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-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><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">Abstract­Party</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAdministrator()" class="member-name-link">get­Administrator</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the organization responsible for defining the characteristics of the location instance.</div>
</div>
<div class="col-first odd-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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;? extends <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">International­String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAlternativeGeographicIdentifiers()" class="member-name-link">get­Alternative­Geographic­Identifiers</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns other identifier(s) for the location instance.</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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">Abstract­Location</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChildren()" class="member-name-link">get­Children</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns location instances of a different location type which subdivides this location instance.</div>
</div>
<div class="col-first odd-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/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEnvelope()" class="member-name-link">get­Envelope</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns an envelope that encompass the location.</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/metadata/extent/GeographicExtent.html" title="class or interface in org.opengis.metadata.extent" class="external-link">Geographic­Extent</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGeographicExtent()" class="member-name-link">get­Geographic­Extent</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a description of the location instance.</div>
</div>
<div class="col-first odd-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">International­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="#getGeographicIdentifier()" class="member-name-link">get­Geographic­Identifier</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a unique identifier for the location instance.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">Modifiable­Location­Type</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocationType()" class="member-name-link">get­Location­Type</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a description of the nature of this geographic identifier.</div>
</div>
<div class="col-first odd-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/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">Abstract­Location</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParents()" class="member-name-link">get­Parents</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns location instances of a different location type, for which this location instance is a sub-division.</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/geometry/coordinate/Position.html" title="class or interface in org.opengis.geometry.coordinate" class="external-link">Position</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">get­Position</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns coordinates of a representative point for the location instance.</div>
</div>
<div class="col-first odd-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/metadata/extent/TemporalExtent.html" title="class or interface in org.opengis.metadata.extent" class="external-link">Temporal­Extent</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTemporalExtent()" class="member-name-link">get­Temporal­Extent</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the date of creation of this version of the location instance.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">to­String</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a string representation of this location.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</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">notify­All</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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.sis.referencing.gazetteer.ModifiableLocationType,java.lang.CharSequence)">
<h3>AbstractLocation</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">AbstractLocation</span><wbr><span class="parameters">(<a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a>&nbsp;type,
<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">CharSequence</a>&nbsp;identifier)</span></div>
<div class="block">Creates a new location for the given geographic identifier.
This constructor accepts <code>null</code> arguments, but this is not recommended.
<div class="warning"><b>Upcoming API change — generalization</b><br>
in a future SIS version, the type of <code>type</code> argument 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>Parameters:</dt>
<dd><code>type</code> - the description of the nature of this geographic identifier.</dd>
<dd><code>identifier</code> - the geographic identifier to be returned by <a href="#getGeographicIdentifier()"><code>get­Geographic­Identifier()</code></a>.</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="getGeographicIdentifier()">
<h3>getGeographicIdentifier</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getGeographicIdentifier</span>()</div>
<div class="block">Returns a unique identifier for the location instance. The methods of identifying locations is specified
by the <a href="ModifiableLocationType.html#getIdentifications()">location type identifications</a>.
In order to ensure that a geographic identifier is unique within a wider geographic domain,
the geographic identifier may need to include an identifier of an instance of a parent location type,
for example “Paris, Texas”.
<h4 id="examples-heading">Examples</h4>
If <code>Location­Type​.get­Identifications()</code> contain “name”, then geographic identifiers may be country
names like “Japan” or “France”, or places like “Eiffel Tower”. If location type identifications contain
“code”, then geographic identifiers may be “SW1P 3AD” postcode.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>unique identifier for the location instance.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="ModifiableLocationType.html#getIdentifications()"><code>Modifiable­Location­Type​.get­Identifications()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAlternativeGeographicIdentifiers()">
<h3>getAlternativeGeographicIdentifiers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <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>&gt;</span>&nbsp;<span class="element-name">getAlternativeGeographicIdentifiers</span>()</div>
<div class="block">Returns other identifier(s) for the location instance.
The default implementation returns an empty set.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>other identifier(s) for the location instance, or an empty collection if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTemporalExtent()">
<h3>getTemporalExtent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/TemporalExtent.html" title="class or interface in org.opengis.metadata.extent" class="external-link">TemporalExtent</a></span>&nbsp;<span class="element-name">getTemporalExtent</span>()</div>
<div class="block">Returns the date of creation of this version of the location instance.
The default implementation returns <code>null</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>date of creation of this version of the location instance, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getGeographicExtent()">
<h3>getGeographicExtent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/GeographicExtent.html" title="class or interface in org.opengis.metadata.extent" class="external-link">GeographicExtent</a></span>&nbsp;<span class="element-name">getGeographicExtent</span>()</div>
<div class="block">Returns a description of the location instance. This properties is mandatory according ISO 19112,
but Apache SIS nevertheless allows <code>null</code> value. If non-null, SIS implementations typically
provide instances of <a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent">geographic bounding boxes</a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>description of the location instance, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent"><code>Default­Geographic­Bounding­Box</code></a></li>
<li><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/extent/DefaultBoundingPolygon.html" title="class in org.apache.sis.metadata.iso.extent"><code>Default­Bounding­Polygon</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getEnvelope()">
<h3>getEnvelope</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a></span>&nbsp;<span class="element-name">getEnvelope</span>()</div>
<div class="block">Returns an envelope that encompass the location. This property is partially redundant with
<a href="#getGeographicExtent()"><code>get­Geographic­Extent()</code></a>, except that this method allows envelopes in non-geographic CRS.
<p>The default implementation copies the <a href="#getGeographicExtent()"><code>get­Geographic­Extent()</code></a> in a new envelope associated
to the <a href="../../../../../../org.apache.sis.referencing/org/apache/sis/referencing/CommonCRS.html#defaultGeographic()">default geographic CRS</a>.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>envelope that encompass the location, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPosition()">
<h3>getPosition</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/coordinate/Position.html" title="class or interface in org.opengis.geometry.coordinate" class="external-link">Position</a></span>&nbsp;<span class="element-name">getPosition</span>()</div>
<div class="block">Returns coordinates of a representative point for the location instance.
This is typically (but not necessarily) the centroid of the location instance.
<p>The default implementation returns the <a href="#getEnvelope()">getEnvelope()</a> median position.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>coordinates of a representative point for the location instance, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLocationType()">
<h3>getLocationType</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a></span>&nbsp;<span class="element-name">getLocationType</span>()</div>
<div class="block">Returns a description of the nature of this geographic identifier.
<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​.referencing​.gazetteer​.Location</code> interface.
This change is pending GeoAPI revision.
If applied, this method will be made non-final.</div></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the nature of the identifier and its associated geographic location.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAdministrator()">
<h3>getAdministrator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getAdministrator</span>()</div>
<div class="block">Returns the organization responsible for defining the characteristics of the location instance.
The default implementation returns the <a href="ModifiableLocationType.html#getOwner()">owner</a>.
<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>organization responsible for defining the characteristics of the location instance, or <code>null</code>.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="ModifiableLocationType.html#getOwner()"><code>Modifiable­Location­Type​.get­Owner()</code></a></li>
<li><a href="ReferencingByIdentifiers.html#getOverallOwner()"><code>Referencing­By­Identifiers​.get­Overall­Owner()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getParents()">
<h3>getParents</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>&gt;</span>&nbsp;<span class="element-name">getParents</span>()</div>
<div class="block">Returns location instances of a different location type, for which this location instance is a sub-division.
The default implementation returns an empty list.
<div class="warning"><b>Upcoming API change — generalization</b><br>
in a future SIS version, the type of collection elements 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>parent locations, or an empty collection if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="ModifiableLocationType.html#getParents()"><code>Modifiable­Location­Type​.get­Parents()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getChildren()">
<h3>getChildren</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>&gt;</span>&nbsp;<span class="element-name">getChildren</span>()</div>
<div class="block">Returns location instances of a different location type which subdivides this location instance.
The default implementation returns an empty list.
<div class="warning"><b>Upcoming API change — generalization</b><br>
in a future SIS version, the type of collection elements 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>child locations, or an empty collection if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="ModifiableLocationType.html#getChildren()"><code>Modifiable­Location­Type​.get­Children()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block">Returns a string representation of this location.
This representation is mostly for debugging purpose and may change in any future Apache SIS version.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt>Returns:</dt>
<dd>a string representation of this location for debugging purpose.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>