Google Git
Sign in
apache / sis-site / 742f5abfede39cb998f99b1d3128f30817895bb1 / . / org / apache / sis / storage / DataSet.html
blob: 9f95913dc9ca0649f27924dbceb4a59cbb00629d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>DataSet (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.storage, interface: DataSet">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.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="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</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>Constr&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>Constr&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="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage</a></div>
<h1 title="Interface DataSet" class="title">Interface DataSet</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="FeatureSet.html" title="interface in org.apache.sis.storage">Feature­Set</a></code>, <code><a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</a></code>, <code><a href="WritableFeatureSet.html" title="interface in org.apache.sis.storage">Writable­Feature­Set</a></code>, <code><a href="WritableGridCoverageResource.html" title="interface in org.apache.sis.storage">Writable­Grid­Coverage­Resource</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractFeatureSet.html" title="class in org.apache.sis.storage">Abstract­Feature­Set</a></code>, <code><a href="AbstractGridCoverageResource.html" title="class in org.apache.sis.storage">Abstract­Grid­Coverage­Resource</a></code>, <code><a href="aggregate/ConcatenatedFeatureSet.html" title="class in org.apache.sis.storage.aggregate">Concatenated­Feature­Set</a></code>, <code><a href="aggregate/JoinFeatureSet.html" title="class in org.apache.sis.storage.aggregate">Join­Feature­Set</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DataSet</span><span class="extends-implements">
extends <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></span></div>
<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>Data­Set</code> subtype.
The actual values are provided by methods defined in <code>Data­Set</code> subtypes.
<div class="note"><b>Example:</b>
the features contained in a <code>Data­Set</code> could be all bridges in a city. A <code>Data­Set</code> can be associated to
one <code>Feature­Type</code> which specifies that all bridges shall have <code>"construction date"</code> and <code>"height"</code>
attributes, and an arbitrary number of <code>Feature</code> instances which contains the actual values for all bridges in
the dataset.</div>
<h2>Metadata</h2>
Datasets should have <a href="Resource.html#getMetadata()"><code>metadata</code></a> /
<a href="../metadata/iso/DefaultMetadata.html#getMetadataScopes()"><code>metadata­Scope</code></a> /
<a href="../metadata/iso/DefaultMetadataScope.html#getResourceScope()"><code>resource­Scope</code></a> sets to
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/maintenance/ScopeCode.html#DATASET" title="class or interface in org.opengis.metadata.maintenance" class="external-link"><code>Scope­Code​.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>Data­Store​.get­Metadata()</code></a>.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.8</dd>
<p><font size="-1">Defined in the <code>sis-storage</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<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>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEnvelope()" class="member-name-link">get­Envelope</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the spatiotemporal extent of this resource in its most natural coordinate reference system.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Resource">Methods inherited from interface&nbsp;<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)">add­Listener</a>, <a href="Resource.html#getIdentifier()">get­Identifier</a>, <a href="Resource.html#getMetadata()">get­Metadata</a>, <a href="Resource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">remove­Listener</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getEnvelope()">
<h3>getEnvelope</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getEnvelope</span>()
throws <span class="exceptions"><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<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>identification­Info</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>reference­System­Info</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>).
<h4>Estimated envelopes</h4>
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.
The converse (returning a smaller envelope) should be avoided, but is not strictly forbidden
because some resources may compute the envelope using only a subset of all the resource data.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the spatiotemporal resource extent. May be absent if none or too costly to compute.</dd>
<dt>Throws:</dt>
<dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while reading or computing the envelope.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>