| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>AbstractLocation (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.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="../../../../../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="AbstractLocation (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All 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/AbstractLocation.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.referencing.gazetteer</a></div> |
| <h2 title="Class AbstractLocation" class="title">Class AbstractLocation</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>AbstractLocation</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractLocation</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer"><code>ModifiableLocationType</code></a>, |
| <a href="ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer"><code>ReferencingByIdentifiers</code></a>, |
| <a href="LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer"><code>LocationFormat</code></a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing-by-identifiers</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.referencing.gazetteer.ModifiableLocationType,java.lang.CharSequence)">AbstractLocation</a></span>​(<a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new location for the given geographic identifier.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../metadata/iso/citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">AbstractParty</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdministrator()">getAdministrator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the organization responsible for defining the characteristics of the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><? extends <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="#getAlternativeGeographicIdentifiers()">getAlternativeGeographicIdentifiers</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns other identifier(s) for the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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><? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildren()">getChildren</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns location instances of a different location type which subdivides this location instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvelope()">getEnvelope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an envelope that encompass the location.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicExtent</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGeographicExtent()">getGeographicExtent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a description of the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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="#getGeographicIdentifier()">getGeographicIdentifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a unique identifier for the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocationType()">getLocationType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a description of the nature of this geographic identifier.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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><? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParents()">getParents</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns location instances of a different location type, for which this location instance is a sub-division.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/coordinate/Position.html?is-external=true" title="class or interface in org.opengis.geometry.coordinate" class="externalLink">Position</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPosition()">getPosition</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns coordinates of a representative point for the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/TemporalExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">TemporalExtent</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemporalExtent()">getTemporalExtent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the date of creation of this version of the location instance.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this location.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.sis.referencing.gazetteer.ModifiableLocationType,java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractLocation</h4> |
| <pre>protected AbstractLocation​(<a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> identifier)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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>getGeographicIdentifier()</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getGeographicIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGeographicIdentifier</h4> |
| <pre class="methodSignature">public <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> getGeographicIdentifier()</pre> |
| <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>. |
| |
| <div class="note"><b>Examples:</b> |
| if <code>LocationType.getIdentifications()</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> |
| |
| 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”.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>unique identifier for the location instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ModifiableLocationType.html#getIdentifications()"><code>ModifiableLocationType.getIdentifications()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAlternativeGeographicIdentifiers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlternativeGeographicIdentifiers</h4> |
| <pre class="methodSignature">public <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><? extends <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>> getAlternativeGeographicIdentifiers()</pre> |
| <div class="block">Returns other identifier(s) for the location instance. |
| The default implementation returns an empty set.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>other identifier(s) for the location instance, or an empty collection if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTemporalExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemporalExtent</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/TemporalExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">TemporalExtent</a> getTemporalExtent()</pre> |
| <div class="block">Returns the date of creation of this version of the location instance. |
| The default implementation returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>date of creation of this version of the location instance, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGeographicExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGeographicExtent</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicExtent.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicExtent</a> getGeographicExtent()</pre> |
| <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="../../metadata/iso/extent/DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent">geographic bounding boxes</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>description of the location instance, or <code>null</code> if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../metadata/iso/extent/DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultGeographicBoundingBox</code></a>, |
| <a href="../../metadata/iso/extent/DefaultBoundingPolygon.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultBoundingPolygon</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEnvelope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnvelope</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> getEnvelope()</pre> |
| <div class="block">Returns an envelope that encompass the location. This property is partially redundant with |
| <a href="#getGeographicExtent()"><code>getGeographicExtent()</code></a>, except that this method allows envelopes in non-geographic CRS. |
| |
| <p>The default implementation copies the <a href="#getGeographicExtent()"><code>getGeographicExtent()</code></a> in a new envelope associated |
| to the <a href="../CommonCRS.html#defaultGeographic()">default geographic CRS</a>.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>envelope that encompass the location, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPosition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPosition</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/coordinate/Position.html?is-external=true" title="class or interface in org.opengis.geometry.coordinate" class="externalLink">Position</a> getPosition()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>coordinates of a representative point for the location instance, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocationType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocationType</h4> |
| <pre class="methodSignature">public final <a href="ModifiableLocationType.html" title="class in org.apache.sis.referencing.gazetteer">ModifiableLocationType</a> getLocationType()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the nature of the identifier and its associated geographic location.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAdministrator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdministrator</h4> |
| <pre class="methodSignature">public <a href="../../metadata/iso/citation/AbstractParty.html" title="class in org.apache.sis.metadata.iso.citation">AbstractParty</a> getAdministrator()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>organization responsible for defining the characteristics of the location instance, or <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ModifiableLocationType.html#getOwner()"><code>ModifiableLocationType.getOwner()</code></a>, |
| <a href="ReferencingByIdentifiers.html#getOverallOwner()"><code>ReferencingByIdentifiers.getOverallOwner()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParents()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParents</h4> |
| <pre class="methodSignature">public <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><? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>> getParents()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parent locations, or an empty collection if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ModifiableLocationType.html#getParents()"><code>ModifiableLocationType.getParents()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChildren()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildren</h4> |
| <pre class="methodSignature">public <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><? extends <a href="AbstractLocation.html" title="class in org.apache.sis.referencing.gazetteer">AbstractLocation</a>> getChildren()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>child locations, or an empty collection if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ModifiableLocationType.html#getChildren()"><code>ModifiableLocationType.getChildren()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString()</pre> |
| <div class="block">Returns a string representation of this location. |
| This representation is mostly for debugging purpose and may change in any future Apache SIS version.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this location for debugging purpose.</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/AbstractLocation.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |