| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.metadata.iso.extent (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.metadata, package: org.apache.sis.metadata.iso.extent"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.metadata.iso.extent package"> |
| <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="package-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../../module-summary.html">org.apache.sis.metadata</a></div> |
| <h1 title="Package org.apache.sis.metadata.iso.extent" class="title">Package org.apache.sis.metadata.iso.extent</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.metadata.iso.extent</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Information about spatial, vertical, and temporal extent. |
| An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/package-summary.html" class="external-link">OpenGIS® javadoc</a>. |
| The remaining discussion on this page is specific to the SIS implementation. |
| |
| <h2 id="overview-heading">Overview</h2> |
| For a global overview of metadata in SIS, see the <a href="../../package-summary.html"><code>org.apache.sis.metadata</code></a> package javadoc. |
| |
| <table class="sis"> |
| <caption>Package overview</caption> |
| <tr> |
| <th>Class hierarchy</th> |
| <th class="sep">Aggregation hierarchy</th> |
| </tr><tr><td style="width: 50%; white-space: nowrap"> |
| <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISO 19115 metadata</a><br> |
| <code> ├─</code> <a href="DefaultExtent.html" title="class in org.apache.sis.metadata.iso.extent">Extent</a><br> |
| <code> ├─</code> <a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">Geographic extent</a> «abstract»<br> |
| <code> │ ├─</code> <a href="DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent">Geographic bounding box</a><br> |
| <code> │ ├─</code> <a href="DefaultGeographicDescription.html" title="class in org.apache.sis.metadata.iso.extent">Geographic description</a><br> |
| <code> │ └─</code> <a href="DefaultBoundingPolygon.html" title="class in org.apache.sis.metadata.iso.extent">Bounding polygon</a><br> |
| <code> ├─</code> <a href="DefaultVerticalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Vertical extent</a><br> |
| <code> └─</code> <a href="DefaultTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Temporal extent</a><br> |
| <code> └─</code> <a href="DefaultSpatialTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Spatial temporal extent</a><br> |
| </td><td class="sep" style="width: 50%; white-space: nowrap"> |
| <a href="DefaultExtent.html" title="class in org.apache.sis.metadata.iso.extent">Extent</a><br> |
| <code> ├─</code> <a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">Geographic extent</a> «abstract»<br> |
| <code> ├─</code> <a href="DefaultVerticalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Vertical extent</a><br> |
| <code> └─</code> <a href="DefaultTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Temporal extent</a><br> |
| <a href="DefaultSpatialTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">Spatial temporal extent</a><br> |
| <code> └─</code> <a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">Geographic extent</a> «abstract»<br> |
| <a href="DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent">Geographic bounding box</a><br> |
| <a href="DefaultGeographicDescription.html" title="class in org.apache.sis.metadata.iso.extent">Geographic description</a><br> |
| <a href="DefaultBoundingPolygon.html" title="class in org.apache.sis.metadata.iso.extent">Bounding polygon</a><br> |
| </td></tr></table> |
| |
| <p>In addition to the standard properties, SIS provides the following methods:</p> |
| <ul> |
| <li><a href="Extents.html" title="class in org.apache.sis.metadata.iso.extent"><code>Extents</code></a> |
| <ul> |
| <li><a href="Extents.html#getGeographicBoundingBox(org.opengis.metadata.Metadata)"><code>getGeographicBoundingBox(Extent)</code></a> |
| for extracting a global geographic bounding box.</li> |
| |
| <li><a href="Extents.html#intersection(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.metadata.extent.GeographicBoundingBox)"><code>intersection(GeographicBoundingBox, GeographicBoundingBox)</code></a> |
| for computing the intersection of two geographic bounding boxes.</li> |
| |
| <li><a href="Extents.html#area(org.opengis.metadata.extent.GeographicBoundingBox)"><code>area(GeographicBoundingBox)</code></a> |
| for estimating the area of a geographic bounding box.</li> |
| </ul> |
| </li> |
| <li><a href="DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultGeographicBoundingBox</code></a> |
| <ul> |
| <li><a href="DefaultGeographicBoundingBox.html#setBounds(double,double,double,double)"><code>setBounds(double, double, double, double)</code></a> |
| for setting the extent from (λ,φ) values.</li> |
| |
| <li><a href="DefaultGeographicBoundingBox.html#setBounds(org.opengis.geometry.Envelope)"><code>setBounds(Envelope)</code></a> |
| for setting the extent from the given envelope.</li> |
| |
| <li><a href="DefaultGeographicBoundingBox.html#setBounds(org.opengis.metadata.extent.GeographicBoundingBox)"><code>setBounds(GeographicBoundingBox)</code></a> |
| for setting the extent from another bounding box.</li> |
| |
| <li><a href="DefaultGeographicBoundingBox.html#add(org.opengis.metadata.extent.GeographicBoundingBox)"><code>add(GeographicBoundingBox)</code></a> |
| for expanding this extent to include another bounding box.</li> |
| |
| <li><a href="DefaultGeographicBoundingBox.html#intersect(org.opengis.metadata.extent.GeographicBoundingBox)"><code>intersect(GeographicBoundingBox)</code></a> |
| for the intersection between the two bounding boxes.</li> |
| </ul> |
| </li> |
| <li><a href="DefaultVerticalExtent.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultVerticalExtent</code></a> |
| <ul> |
| <li><a href="DefaultVerticalExtent.html#setBounds(org.opengis.geometry.Envelope)"><code>setBounds(Envelope)</code></a> |
| for setting the vertical element from the given envelope.</li> |
| </ul> |
| </li> |
| <li><a href="DefaultTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultTemporalExtent</code></a> |
| <ul> |
| <li><a href="DefaultTemporalExtent.html#setBounds(java.util.Date,java.util.Date)"><code>setBounds(Date, Date)</code></a> |
| for setting the temporal element from the start time and end time.</li> |
| |
| <li><a href="DefaultTemporalExtent.html#setBounds(org.opengis.geometry.Envelope)"><code>setBounds(Envelope)</code></a> |
| for setting the temporal element from the given envelope.</li> |
| </ul> |
| </li> |
| <li><a href="DefaultExtent.html" title="class in org.apache.sis.metadata.iso.extent"><code>DefaultExtent</code></a> |
| <ul> |
| <li><a href="DefaultExtent.html#addElements(org.opengis.geometry.Envelope)"><code>addElements(Extent)</code></a> |
| for adding extent elements inferred from the given envelope.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h2 id="null-values-nil-objects-and-collections-heading">Null values, nil objects and collections</h2> |
| All constructors and setter methods accept <code>null</code> arguments. |
| A null argument value means that the metadata element cannot be provided, and the reason for that is unspecified. |
| Alternatively, users can specify why a metadata element is missing by providing a value created by |
| <a href="../../../xml/NilReason.html#createNilObject(java.lang.Class)"><code>NilReason.createNilObject(Class)</code></a>. |
| |
| <p>Unless otherwise noted in the Javadoc, all getter methods may return an empty collection, |
| an empty array or <code>null</code> if the type is neither a collection or an array. |
| Note that non-null values may be <a href="../../../xml/NilObject.html" title="interface in org.apache.sis.xml"><code>NilObject</code></a>s.</p> |
| |
| <p>Unless the metadata object has been marked as unmodifiable and unless otherwise noted in the Javadoc, |
| all collections returned by getter methods are <em>live</em>: adding new elements in the collection |
| modify directly the underlying metadata object.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.metadata.iso</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Root package for ISO 19115 metadata about resources (data or services).</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="caption"><span>Classes</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractGeographicExtent.html" title="class in org.apache.sis.metadata.iso.extent">AbstractGeographicExtent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for geographic area of the dataset.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultBoundingPolygon.html" title="class in org.apache.sis.metadata.iso.extent">DefaultBoundingPolygon</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Boundary enclosing the dataset, expressed as the closed set of |
| (<var>x</var>,<var>y</var>) coordinates of the polygon.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultExtent.html" title="class in org.apache.sis.metadata.iso.extent">DefaultExtent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Information about spatial, vertical, and temporal extent.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultGeographicBoundingBox.html" title="class in org.apache.sis.metadata.iso.extent">DefaultGeographicBoundingBox</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Geographic position of the dataset.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultGeographicDescription.html" title="class in org.apache.sis.metadata.iso.extent">DefaultGeographicDescription</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Description of the geographic area using identifiers.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultSpatialTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">DefaultSpatialTemporalExtent</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Extent with respect to date/time and spatial boundaries.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultTemporalExtent.html" title="class in org.apache.sis.metadata.iso.extent">DefaultTemporalExtent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Time period covered by the content of the dataset.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultVerticalExtent.html" title="class in org.apache.sis.metadata.iso.extent">DefaultVerticalExtent</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Vertical domain of dataset.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Extents.html" title="class in org.apache.sis.metadata.iso.extent">Extents</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Convenience static methods for extracting information from <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/extent/Extent.html" title="class or interface in org.opengis.metadata.extent" class="external-link"><code>Extent</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Metadata</code></a> objects.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
