| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>Tile (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.tiling, interface: Tile"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.storage.tiling.Tile interface"> |
| <meta name="keywords" content="getIndices()"> |
| <meta name="keywords" content="getStatus()"> |
| <meta name="keywords" content="getResource()"> |
| <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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Tile.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.sis.storage.tiling</a></div> |
| <h1 title="Interface Tile" class="title">Interface Tile</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Tile</span></div> |
| <div class="block">A small hyper-rectangular representation of data which is part of a tiling scheme. |
| A tile is uniquely defined in a tile matrix by an integer index in each dimension. |
| Tiles can be a coverage subsets, or a feature based representation (e.g. vector tiles). |
| |
| <p>All methods in this interface return non-null values.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="TileMatrix.html#getTiles(org.apache.sis.coverage.grid.GridExtent,boolean)"><code>TileMatrix.getTiles(GridExtent, boolean)</code></a></li> |
| </ul> |
| </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>long[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getIndices()" class="member-name-link">getIndices</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 indices of this tile in the <code>TileMatrix</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResource()" class="member-name-link">getResource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the tile content as a resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TileStatus.html" title="enum class in org.apache.sis.storage.tiling">TileStatus</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStatus()" class="member-name-link">getStatus</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 information about whether the tile failed to load.</div> |
| </div> |
| </div> |
| </div> |
| </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="getIndices()"> |
| <h3>getIndices</h3> |
| <div class="member-signature"><span class="return-type">long[]</span> <span class="element-name">getIndices</span>()</div> |
| <div class="block">Returns the indices of this tile in the <code>TileMatrix</code>. |
| If this tile was obtained by a call to <a href="TileMatrix.html#getTile(long...)"><code>TileMatrix.getTile(long...)</code></a>, |
| then the returned array contains the indices that were given in that call. |
| |
| <p>The returned array contains coordinates in the space defined by |
| the <a href="../../coverage/grid/GridGeometry.html#getExtent()">extent</a> of |
| the <a href="TileMatrix.html#getTilingScheme()">tiling scheme</a>. |
| As such, it complies with the following constraints:</p> |
| <ul> |
| <li>The array length is equal to <a href="../../coverage/grid/GridExtent.html#getDimension()"><code>GridExtent.getDimension()</code></a>.</li> |
| <li>The axis order — usually (<var>column</var>, <var>row/</var>) — is the |
| <a href="../../coverage/grid/GridExtent.html#getAxisType(int)">extent axis</a> order.</li> |
| <li>Values are between the <a href="../../coverage/grid/GridExtent.html#getLow(int)">extent low</a> |
| and <a href="../../coverage/grid/GridExtent.html#getHigh(int)">high</a> values, inclusive.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>indices of this tile in the <a href="TileMatrix.html" title="interface in org.apache.sis.storage.tiling"><code>TileMatrix</code></a>, |
| as coordinates inside the matrix <a href="../../coverage/grid/GridExtent.html" title="class in org.apache.sis.coverage.grid"><code>GridExtent</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="TileMatrix.html#getTile(long...)"><code>TileMatrix.getTile(long...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatus()"> |
| <h3>getStatus</h3> |
| <div class="member-signature"><span class="return-type"><a href="TileStatus.html" title="enum class in org.apache.sis.storage.tiling">TileStatus</a></span> <span class="element-name">getStatus</span>()</div> |
| <div class="block">Returns information about whether the tile failed to load. |
| The return value can be <a href="TileStatus.html#EXISTS"><code>TileStatus.EXISTS</code></a> or <a href="TileStatus.html#IN_ERROR"><code>TileStatus.IN_ERROR</code></a>; |
| other enumeration values should not happen after a user successfully obtained this <code>Tile</code> instance. |
| |
| <h4>State transition</h4> |
| <a href="TileStatus.html#EXISTS"><code>TileStatus.EXISTS</code></a> is not a guarantee that a call to <a href="#getResource()"><code>getResource()</code></a> will succeed. |
| The error may be detected only during the first attempt to read the resource. |
| Consequently, this method may initially return <code>EXISTS</code>, |
| then return <code>IN_ERROR</code> later after the first read attempt.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>information about the availability of this tile.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="TileMatrix.html#getTileStatus(long...)"><code>TileMatrix.getTileStatus(long...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResource()"> |
| <h3>getResource</h3> |
| <div class="member-signature"><span class="return-type"><a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a></span> <span class="element-name">getResource</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 tile content as a resource. |
| The resource type is typically <a href="../GridCoverageResource.html" title="interface in org.apache.sis.storage"><code>GridCoverageResource</code></a>, |
| but it may also be other types (e.g. vector tiles).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the tile content.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred while reading the content.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
