| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DataSet (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.storage.DataSet interface"> |
| <meta name="keywords" content="getEnvelope()"> |
| <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="DataSet (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DataSet.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.storage</a></div> |
| <h2 title="Interface DataSet" class="title">Interface DataSet</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></code>, <code><a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></code>, <code><a href="WritableFeatureSet.html" title="interface in org.apache.sis.storage">WritableFeatureSet</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">DataSet</span> |
| extends <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></pre> |
| <div class="block">Collection of features that share a common set of attributes or properties. |
| Features may be organized in coverages, but not necessarily. |
| The common set of properties is described by <a href="../feature/DefaultFeatureType.html" title="class in org.apache.sis.feature">feature types</a>, |
| grid geometries or sample dimensions, depending on the <code>DataSet</code> subtype. |
| The actual values are provided by methods defined in <code>DataSet</code> subtypes. |
| |
| <div class="note"><b>Example:</b> |
| the features contained in a <code>DataSet</code> could be all bridges in a city. A <code>DataSet</code> can be associated to |
| one <code>FeatureType</code> which specifies that all bridges shall have <code>"construction date"</code> and <code>"height"</code> |
| attributes, and an arbitrary amount of <code>Feature</code> instances which contains the actual values for all bridges in |
| the dataset.</div> |
| |
| <div class="section">Metadata</div> |
| Datasets should have <a href="Resource.html#getMetadata()"><code>metadata</code></a> / |
| <a href="../metadata/iso/DefaultMetadata.html#getMetadataScopes()"><code>metadataScope</code></a> / |
| <a href="../metadata/iso/DefaultMetadataScope.html#getResourceScope()"><code>resourceScope</code></a> sets to |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/maintenance/ScopeCode.html?is-external=true#DATASET" title="class or interface in org.opengis.metadata.maintenance" class="externalLink"><code>ScopeCode.DATASET</code></a>. |
| If this datasets is part of a series or an <a href="Aggregate.html" title="interface in org.apache.sis.storage"><code>Aggregate</code></a>, the aggregate name should be declared |
| as the <a href="../metadata/iso/DefaultMetadata.html#getParentMetadata()">parent metadata</a>. |
| That parent metadata is often the same instance than <a href="DataStore.html#getMetadata()"><code>DataStore.getMetadata()</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-storage</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<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 the spatiotemporal extent of this resource in its most natural coordinate reference system.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Resource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></h3> |
| <code><a href="Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a>, <a href="Resource.html#getIdentifier()">getIdentifier</a>, <a href="Resource.html#getMetadata()">getMetadata</a>, <a href="Resource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getEnvelope()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEnvelope</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<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() |
| throws <a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <div class="block">Returns the spatiotemporal extent of this resource in its most natural coordinate reference system. |
| The following relationship to <a href="Resource.html#getMetadata()">Resource.getMetadata()</a> should hold (departures may exist): |
| |
| <ul> |
| <li>The envelope should be contained in the union of all geographic, vertical or temporal extents |
| described by <code>metadata</code> / |
| <a href="../metadata/iso/DefaultMetadata.html#getIdentificationInfo()"><code>identificationInfo</code></a> / |
| <a href="../metadata/iso/identification/AbstractIdentification.html#getExtents()"><code>extent</code></a>.</li> |
| <li>The coordinate reference system should be one of the instances returned by |
| <a href="../metadata/iso/DefaultMetadata.html#getReferenceSystemInfo()"><code>referenceSystemInfo</code></a>.</li> |
| </ul> |
| |
| The envelope should use the coordinate reference system (CRS) |
| that most closely matches the geometry of the resource storage. It is often a |
| <a href="../referencing/crs/DefaultProjectedCRS.html" title="class in org.apache.sis.referencing.crs">projected CRS</a>, but other types like |
| <a href="../referencing/crs/DefaultEngineeringCRS.html" title="class in org.apache.sis.referencing.crs">engineering CRS</a> are also allowed. |
| If this resource uses many different CRS with none of them covering all data, then the envelope should use a |
| global system (typically a <a href="../referencing/crs/DefaultGeocentricCRS.html" title="class in org.apache.sis.referencing.crs">geographic CRS</a>). |
| |
| <p>The returned envelope is not necessarily the smallest bounding box encompassing all data. |
| If the smallest envelope is too costly to compute, this method may conservatively return a larger envelope.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the spatiotemporal resource extent. May be absent if none or too costly to compute.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred while reading or computing the envelope.</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/DataSet.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
