| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>GeoTiffStore (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.geotiff.GeoTiffStore class"> |
| <meta name="keywords" content="getOpenParameters()"> |
| <meta name="keywords" content="getIdentifier()"> |
| <meta name="keywords" content="getMetadata()"> |
| <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="../../../../../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="GeoTiffStore (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/GeoTiffStore.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.storage.geotiff</a></div> |
| <h2 title="Class GeoTiffStore" class="title">Class GeoTiffStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>GeoTiffStore</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code>, <code><a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code>, <code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code>, <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">GeoTiffStore</span> |
| extends <a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a> |
| implements <a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></pre> |
| <div class="block">A data store backed by GeoTIFF files.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-geotiff</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.DataStore"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class <a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3> |
| <code><a href="../DataStore.html#listeners">listeners</a>, <a href="../DataStore.html#provider">provider</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.storage.geotiff.GeoTiffStoreProvider,org.apache.sis.storage.StorageConnector)">GeoTiffStore</a></span>​(<a href="GeoTiffStoreProvider.html" title="class in org.apache.sis.storage.geotiff">GeoTiffStoreProvider</a> provider, |
| <a href="../StorageConnector.html" title="class in org.apache.sis.storage">StorageConnector</a> connector)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new GeoTIFF store from the given file, URL or stream object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>><br>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> eventType, |
| <a href="../event/StoreListener.html" title="interface in org.apache.sis.storage.event">StoreListener</a><? super T> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a listener to notify when the specified kind of event occurs in this data store.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Closes this GeoTIFF store and releases any underlying resources.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#components()">components</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns descriptions of all images in this GeoTIFF file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findResource(java.lang.String)">findResource</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sequence)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the image at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentifier()">getIdentifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an identifier constructed from the name of the TIFF file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Metadata.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Metadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetadata()">getMetadata</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns information about the dataset as a whole.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenParameters()">getOpenParameters</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the parameters used to open this GeoTIFF data store.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.DataStore"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></h3> |
| <code><a href="../DataStore.html#addWarningListener(org.apache.sis.util.logging.WarningListener)">addWarningListener</a>, <a href="../DataStore.html#getDisplayName()">getDisplayName</a>, <a href="../DataStore.html#getLocale()">getLocale</a>, <a href="../DataStore.html#getProvider()">getProvider</a>, <a href="../DataStore.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</a>, <a href="../DataStore.html#removeWarningListener(org.apache.sis.util.logging.WarningListener)">removeWarningListener</a>, <a href="../DataStore.html#setLocale(java.util.Locale)">setLocale</a>, <a href="../DataStore.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.sis.storage.geotiff.GeoTiffStoreProvider,org.apache.sis.storage.StorageConnector)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GeoTiffStore</h4> |
| <pre>public GeoTiffStore​(<a href="GeoTiffStoreProvider.html" title="class in org.apache.sis.storage.geotiff">GeoTiffStoreProvider</a> provider, |
| <a href="../StorageConnector.html" title="class in org.apache.sis.storage">StorageConnector</a> connector) |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <div class="block">Creates a new GeoTIFF store from the given file, URL or stream object. |
| This constructor invokes <a href="../StorageConnector.html#closeAllExcept(java.lang.Object)"><code>StorageConnector.closeAllExcept(Object)</code></a>, |
| keeping open only the needed resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>provider</code> - the factory that created this <code>DataStore</code> instance, or <code>null</code> if unspecified.</dd> |
| <dd><code>connector</code> - information about the storage (URL, stream, <i>etc</i>).</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 opening the GeoTIFF file.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getOpenParameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenParameters</h4> |
| <pre class="methodSignature">public <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/parameter/ParameterValueGroup.html?is-external=true" title="class or interface in org.opengis.parameter" class="externalLink">ParameterValueGroup</a>> getOpenParameters()</pre> |
| <div class="block">Returns the parameters used to open this GeoTIFF data store. |
| The parameters are described by <a href="GeoTiffStoreProvider.html#getOpenParameters()"><code>GeoTiffStoreProvider.getOpenParameters()</code></a> and contains at least |
| a parameter named <a href="../DataStoreProvider.html#LOCATION">"location"</a> with a <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a> value. |
| The return value may be empty if the storage input can not be described by a URI |
| (for example a GeoTIFF file reading directly from a <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/ReadableByteChannel.html?is-external=true" title="class or interface in java.nio.channels" class="externalLink"><code>ReadableByteChannel</code></a>).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../DataStore.html#getOpenParameters()">getOpenParameters</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parameters used for opening this data store.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../DataStoreProvider.html#getOpenParameters()"><code>DataStoreProvider.getOpenParameters()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentifier</h4> |
| <pre class="methodSignature">public <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/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>> getIdentifier() |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <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/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URI</code></a>, for example an <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>URL</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>File</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file" class="externalLink"><code>Path</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Resource.html#getIdentifier()">getIdentifier</a></code> in interface <code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../DataStore.html#getIdentifier()">getIdentifier</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the identifier derived from the filename.</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 fetching the identifier.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../DataStore.html#getMetadata()"><code>DataStore.getMetadata()</code></a>, |
| <a href="../DataStore.html#getDisplayName()"><code>DataStore.getDisplayName()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Metadata.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink">Metadata</a> getMetadata() |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Resource.html#getMetadata()">getMetadata</a></code> in interface <code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../DataStore.html#getMetadata()">getMetadata</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>information about the dataset.</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 the data.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../DataStore.html#getIdentifier()"><code>DataStore.getIdentifier()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="components()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>components</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>> components() |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <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="../../util/collection/BackingStoreException.html" title="class in org.apache.sis.util.collection"><code>BackingStoreException</code></a> will be thrown with a <a href="../DataStoreException.html" title="class in org.apache.sis.storage"><code>DataStoreException</code></a> as its cause.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Aggregate.html#components()">components</a></code> in interface <code><a href="../Aggregate.html" title="interface in org.apache.sis.storage">Aggregate</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>descriptions of all images in this GeoTIFF file.</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 fetching the image descriptions.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findResource</h4> |
| <pre class="methodSignature">public <a href="../GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a> findResource​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sequence) |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <div class="block">Returns the image at the given index. Images numbering starts at 1.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../DataStore.html#findResource(java.lang.String)">findResource</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sequence</code> - string representation of the image index, starting at 1.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>image at the given index.</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 the requested image can not be obtained.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Resource.html#getIdentifier()"><code>Resource.getIdentifier()</code></a>, |
| <a href="../FeatureNaming.html" title="class in org.apache.sis.storage"><code>FeatureNaming</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addListener</h4> |
| <pre class="methodSignature">public <T extends <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>> void addListener​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> eventType, |
| <a href="../event/StoreListener.html" title="interface in org.apache.sis.storage.event">StoreListener</a><? super T> listener)</pre> |
| <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="../event/WarningEvent.html" title="class in org.apache.sis.storage.event"><code>WarningEvent</code></a>s; |
| any listener specified for another kind of events will be ignored.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a></code> in interface <code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../DataStore.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - compile-time value of the <code>eventType</code> argument.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>eventType</code> - type of <a href="../event/StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a> to listen (can not be <code>null</code>).</dd> |
| <dd><code>listener</code> - listener to notify about events.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close() |
| throws <a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></pre> |
| <div class="block">Closes this GeoTIFF store and releases any underlying resources.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../DataStore.html#close()">close</a></code> in class <code><a href="../DataStore.html" title="class in org.apache.sis.storage">DataStore</a></code></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 closing the GeoTIFF file.</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/GeoTiffStore.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |