Google Git
Sign in
apache / sis-site / refs/heads/javadoc / . / org.apache.sis.storage.geotiff / org / apache / sis / storage / geotiff / GeoTiffStore.html
blob: 86aba644920c8193bed5c179a54b0ff7f8d6b5a0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>GeoTiffStore (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.storage.geotiff, package: org.apache.sis.storage.geotiff, class: GeoTiffStore">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.storage.geotiff.GeoTiffStore class">
<meta name="keywords" content="getOpenParameters()">
<meta name="keywords" content="getIdentifier()">
<meta name="keywords" content="getMetadata()">
<meta name="keywords" content="getNativeMetadata()">
<meta name="keywords" content="components()">
<meta name="keywords" content="findResource()">
<meta name="keywords" content="addListener()">
<meta name="keywords" content="close()">
<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><a href="#field-summary">Field</a></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><a href="#field-summary">Field</a>&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.storage.geotiff</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage.geotiff</a></div>
<h1 title="Class GeoTiffStore" class="title">Class GeoTiffStore</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"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">DataStore</a>
<div class="inheritance">GeoTiffStore</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">Auto­Closeable</a></code>, <code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code>, <code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></code>, <code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GeoTiffStore</span>
<span class="extends-implements">extends <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">DataStore</a>
implements <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></span></div>
<div class="block">A data store backed by GeoTIFF files.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.8</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-DataStore">Fields inherited from class&nbsp;<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3>
<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#listeners">listeners</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#provider">provider</a></code></div>
</section>
</li>
<!-- ======== 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 two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.storage.DataStore,org.apache.sis.storage.DataStoreProvider,org.apache.sis.storage.StorageConnector,boolean)" class="member-name-link">Geo­Tiff­Store</a><wbr>(<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a>&nbsp;parent,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreProvider.html" title="class in org.apache.sis.storage">Data­Store­Provider</a>&nbsp;provider,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/StorageConnector.html" title="class in org.apache.sis.storage">Storage­Connector</a>&nbsp;connector,
boolean&nbsp;hidden)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new GeoTIFF store as a component of a larger data store.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.storage.geotiff.GeoTiffStoreProvider,org.apache.sis.storage.StorageConnector)" class="member-name-link">Geo­Tiff­Store</a><wbr>(<a href="GeoTiffStoreProvider.html" title="class in org.apache.sis.storage.geotiff">Geo­Tiff­Store­Provider</a>&nbsp;provider,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/StorageConnector.html" title="class in org.apache.sis.storage">Storage­Connector</a>&nbsp;connector)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new GeoTIFF store from the given file, URL or stream object.</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>&lt;T extends <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreEvent.html" title="class in org.apache.sis.storage.event">Store­Event</a>&gt;<br>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)" class="member-name-link">add­Listener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;event­Type,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreListener.html" title="interface in org.apache.sis.storage.event">Store­Listener</a>&lt;? super T&gt;&nbsp;listener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers a listener to notify when the specified kind of event occurs in this data store.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Closes this GeoTIFF store and releases any underlying resources.</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr>&lt;<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</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="#components()" class="member-name-link">components</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 descriptions of all images in this GeoTIFF file.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">Grid­Coverage­Resource</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findResource(java.lang.String)" class="member-name-link">find­Resource</a><wbr>(<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>&nbsp;sequence)</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 image at the given index.</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">Generic­Name</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="#getIdentifier()" class="member-name-link">get­Identifier</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 an identifier constructed from the name of the TIFF file.</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/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetadata()" class="member-name-link">get­Metadata</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 information about the dataset as a whole.</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="../../../../../../org.apache.sis.util/org/apache/sis/util/collection/TreeTable.html" title="interface in org.apache.sis.util.collection">Tree­Table</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="#getNativeMetadata()" class="member-name-link">get­Native­Metadata</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 TIFF tags and GeoTIFF keys as a tree for debugging purpose.</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">Parameter­Value­Group</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="#getOpenParameters()" class="member-name-link">get­Open­Parameters</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 parameters used to open this GeoTIFF data store.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-DataStore">Methods inherited from class&nbsp;<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3>
<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getDisplayName()">get­Display­Name</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getLocale()">get­Locale</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getProvider()">get­Provider</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">remove­Listener</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#setLocale(java.util.Locale)">set­Locale</a>, <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#toString()">to­String</a></code></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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Resource">Methods inherited from interface&nbsp;<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></h3>
<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/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">
<!-- ========= 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.storage.geotiff.GeoTiffStoreProvider,org.apache.sis.storage.StorageConnector)">
<h3>GeoTiffStore</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">GeoTiffStore</span><wbr><span class="parameters">(<a href="GeoTiffStoreProvider.html" title="class in org.apache.sis.storage.geotiff">GeoTiffStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/StorageConnector.html" title="class in org.apache.sis.storage">StorageConnector</a>&nbsp;connector)</span>
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Creates a new GeoTIFF store from the given file, URL or stream object.
This constructor invokes <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/StorageConnector.html#closeAllExcept(java.lang.Object)"><code>Storage­Connector​.close­All­Except(Object)</code></a>,
keeping open only the needed resource.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>provider</code> - the factory that created this <code>Data­Store</code> instance, or <code>null</code> if unspecified.</dd>
<dd><code>connector</code> - information about the storage (URL, stream, <i>etc</i>).</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while opening the GeoTIFF file.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.sis.storage.DataStore,org.apache.sis.storage.DataStoreProvider,org.apache.sis.storage.StorageConnector,boolean)">
<h3>GeoTiffStore</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">GeoTiffStore</span><wbr><span class="parameters">(<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">DataStore</a>&nbsp;parent,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreProvider.html" title="class in org.apache.sis.storage">DataStoreProvider</a>&nbsp;provider,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/StorageConnector.html" title="class in org.apache.sis.storage">StorageConnector</a>&nbsp;connector,
boolean&nbsp;hidden)</span>
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Creates a new GeoTIFF store as a component of a larger data store.
If the <code>hidden</code> parameter is <code>true</code>, some metadata that would normally be
provided in this <code>Geo­Tiff­Store</code> will be provided by individual components instead.
<h4 id="example-heading">Example</h4>
A Landsat data set is a collection of files in a directory or ZIP file,
which includes more than 10 GeoTIFF files (one image per band or product for a scene).
<a href="../../../../../../org.apache.sis.storage.earthobservation/org/apache/sis/storage/landsat/LandsatStore.html" title="class in org.apache.sis.storage.landsat"><code>Landsat­Store</code></a> is a data store opening the Landsat
metadata file as the main file, then opening each band/product using a GeoTIFF data store.
Those bands/products are components of the Landsat data store.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>parent</code> - the parent that contains this new GeoTIFF store component, or <code>null</code> if none.</dd>
<dd><code>provider</code> - the factory that created this <code>Data­Store</code> instance, or <code>null</code> if unspecified.</dd>
<dd><code>connector</code> - information about the storage (URL, stream, <i>etc</i>).</dd>
<dd><code>hidden</code> - <code>true</code> if this GeoTIFF store will not be directly accessible from the parent.
It is the case if the parent store will expose only some <a href="#components()">components</a> instead of the GeoTIFF store itself.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while opening the GeoTIFF file.</dd>
<dt>Since:</dt>
<dd>1.1</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="getOpenParameters()">
<h3>getOpenParameters</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/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/parameter/ParameterValueGroup.html" title="class or interface in org.opengis.parameter" class="external-link">ParameterValueGroup</a>&gt;</span>&nbsp;<span class="element-name">getOpenParameters</span>()</div>
<div class="block">Returns the parameters used to open this GeoTIFF data store.
The parameters are described by <a href="GeoTiffStoreProvider.html#getOpenParameters()"><code>Geo­Tiff­Store­Provider​.get­Open­Parameters()</code></a> and contains at least
a parameter named <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreProvider.html#LOCATION">"location"</a> with a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a> value.
The return value may be empty if the storage input cannot be described by a URI
(for example a GeoTIFF file reading directly from a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels" class="external-link"><code>Readable­Byte­Channel</code></a>).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getOpenParameters()">get­Open­Parameters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>parameters used for opening this data store.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreProvider.html#getOpenParameters()"><code>Data­Store­Provider​.get­Open­Parameters()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdentifier()">
<h3>getIdentifier</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/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/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link">GenericName</a>&gt;</span>&nbsp;<span class="element-name">getIdentifier</span>()
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns an identifier constructed from the name of the TIFF file.
An identifier is available only if the storage input specified at construction time was something convertible to
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link"><code>URI</code></a>, for example an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link"><code>URL</code></a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link"><code>File</code></a> or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>Path</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html#getIdentifier()">get­Identifier</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getIdentifier()">get­Identifier</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>the identifier derived from the filename.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while fetching the identifier.</dd>
<dt>Since:</dt>
<dd>1.0</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getMetadata()"><code>Data­Store​.get­Metadata()</code></a></li>
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getDisplayName()"><code>Data­Store​.get­Display­Name()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMetadata()">
<h3>getMetadata</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/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></span>&nbsp;<span class="element-name">getMetadata</span>()
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns information about the dataset as a whole. The returned metadata object can contain information
such as the spatiotemporal extent of the dataset, contact information about the creator or distributor,
data quality, usage constraints and more.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html#getMetadata()">get­Metadata</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getMetadata()">get­Metadata</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>information about the dataset.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while reading the data.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getIdentifier()"><code>Data­Store​.get­Identifier()</code></a></li>
<li><a href="../../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/DefaultMetadata.html#deepCopy(org.opengis.metadata.Metadata)"><code>Default­Metadata​.deep­Copy(Metadata)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNativeMetadata()">
<h3>getNativeMetadata</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="../../../../../../org.apache.sis.util/org/apache/sis/util/collection/TreeTable.html" title="interface in org.apache.sis.util.collection">TreeTable</a>&gt;</span>&nbsp;<span class="element-name">getNativeMetadata</span>()
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns TIFF tags and GeoTIFF keys as a tree for debugging purpose.
The tags and keys appear in the order they are declared in the file.
The columns are tag numerical code as an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a>,
tag name as a <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"><code>String</code></a> and value as an <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"><code>Object</code></a>.
<p>This method should not be invoked during normal operations;
the <a href="#getMetadata()">standard metadata</a> are preferred
because they allow abstraction of data format details.
Native metadata should be used only when an information does not appear in standard metadata,
or for debugging purposes.</p>
<h4 id="performance-note-heading">Performance note</h4>
Since this method should not be invoked in normal operations, it has not been tuned for performance.
Invoking this method may cause a lot of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SeekableByteChannel.html#position(long)" title="class or interface in java.nio.channels" class="external-link">seek operations</a>.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#getNativeMetadata()">get­Native­Metadata</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Returns:</dt>
<dd>resources information structured in an implementation-specific way.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while reading the metadata.</dd>
<dt>Since:</dt>
<dd>1.2</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="components()">
<h3>components</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/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>&gt;</span>&nbsp;<span class="element-name">components</span>()
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns descriptions of all images in this GeoTIFF file.
Images are not immediately loaded.
<p>If an error occurs during iteration in the returned collection,
an unchecked <a href="../../../../../../org.apache.sis.util/org/apache/sis/util/collection/BackingStoreException.html" title="class in org.apache.sis.util.collection"><code>Backing­Store­Exception</code></a> will be thrown with a <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage"><code>Data­Store­Exception</code></a> as its cause.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Aggregate.html#components()">components</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code></dd>
<dt>Returns:</dt>
<dd>descriptions of all images in this GeoTIFF file.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while fetching the image descriptions.</dd>
<dt>Since:</dt>
<dd>1.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="findResource(java.lang.String)">
<h3>findResource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></span>&nbsp;<span class="element-name">findResource</span><wbr><span class="parameters">(<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>&nbsp;sequence)</span>
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Returns the image at the given index. Images numbering starts at 1.
If the given string has a scope (e.g. "filename:1"), then the scope</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#findResource(java.lang.String)">find­Resource</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Parameters:</dt>
<dd><code>sequence</code> - string representation of the image index, starting at 1.</dd>
<dt>Returns:</dt>
<dd>image at the given index.</dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if the requested image cannot be obtained.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html#getIdentifier()"><code>Resource​.get­Identifier()</code></a></li>
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/FeatureNaming.html" title="class in org.apache.sis.storage"><code>Feature­Naming</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">
<h3>addListener</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T extends <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>&gt;</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;eventType,
<a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreListener.html" title="interface in org.apache.sis.storage.event">StoreListener</a>&lt;? super T&gt;&nbsp;listener)</span></div>
<div class="block">Registers a listener to notify when the specified kind of event occurs in this data store.
The current implementation of this data store can emit only <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/WarningEvent.html" title="class in org.apache.sis.storage.event"><code>Warning­Event</code></a>s;
any listener specified for another kind of events will be ignored.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">add­Listener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">add­Listener</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Type Parameters:</dt>
<dd><code>T</code> - compile-time value of the <code>event­Type</code> argument.</dd>
<dt>Parameters:</dt>
<dd><code>event­Type</code> - type of <a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreEvent.html" title="class in org.apache.sis.storage.event"><code>Store­Event</code></a> to listen (cannot be <code>null</code>).</dd>
<dd><code>listener</code> - listener to notify about events.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
<div class="block">Closes this GeoTIFF store and releases any underlying resources.
This method can be invoked asynchronously for interrupting a long reading process.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">Auto­Closeable</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html#close()">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/DataStoreException.html" title="class in org.apache.sis.storage">Data­Store­Exception</a></code> - if an error occurred while closing the GeoTIFF file.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../../org.apache.sis.storage/org/apache/sis/storage/event/StoreListeners.html#close()"><code>Store­Listeners​.close()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>