| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>WritableTileMatrixSet (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: WritableTileMatrixSet"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.storage.tiling.WritableTileMatrixSet interface"> |
| <meta name="keywords" content="getTileMatrices()"> |
| <meta name="keywords" content="createTileMatrix()"> |
| <meta name="keywords" content="deleteTileMatrix()"> |
| <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/WritableTileMatrixSet.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 WritableTileMatrixSet" class="title">Interface WritableTileMatrixSet</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="TileMatrixSet.html" title="interface in org.apache.sis.storage.tiling">TileMatrixSet</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WritableTileMatrixSet</span><span class="extends-implements"> |
| extends <a href="TileMatrixSet.html" title="interface in org.apache.sis.storage.tiling">TileMatrixSet</a></span></div> |
| <div class="block">A <code>TileMatrixSet</code> that can write and delete tile matrices. |
| |
| <p>All methods in this interface expect non-null arguments are return non-null values.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-storage</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling">WritableTileMatrix</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createTileMatrix(org.apache.sis.storage.tiling.TileMatrix)" class="member-name-link">createTileMatrix</a><wbr>(<a href="TileMatrix.html" title="interface in org.apache.sis.storage.tiling">TileMatrix</a> tiles)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds the given tile matrix to this set and returns a writable instance for later completion.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deleteTileMatrix(java.lang.String)" class="member-name-link">deleteTileMatrix</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> identifier)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Deletes a <code>TileMatrix</code> identified by the given name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/SortedMap.html" title="class or interface in java.util" class="external-link">SortedMap</a><<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>,<wbr>? extends <a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling">WritableTileMatrix</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTileMatrices()" class="member-name-link">getTileMatrices</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 all <a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling"><code>WritableTileMatrix</code></a> instances in this set, together with their identifiers.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-TileMatrixSet">Methods inherited from interface <a href="TileMatrixSet.html" title="interface in org.apache.sis.storage.tiling">TileMatrixSet</a></h3> |
| <code><a href="TileMatrixSet.html#getCoordinateReferenceSystem()">getCoordinateReferenceSystem</a>, <a href="TileMatrixSet.html#getEnvelope()">getEnvelope</a>, <a href="TileMatrixSet.html#getIdentifier()">getIdentifier</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getTileMatrices()"> |
| <h3>getTileMatrices</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/SortedMap.html" title="class or interface in java.util" class="external-link">SortedMap</a><<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>,<wbr>? extends <a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling">WritableTileMatrix</a>></span> <span class="element-name">getTileMatrices</span>()</div> |
| <div class="block">Returns all <a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling"><code>WritableTileMatrix</code></a> instances in this set, together with their identifiers. |
| For each value in the map, the associated key is <a href="TileMatrix.html#getIdentifier()"><code>TileMatrix.getIdentifier()</code></a>. |
| Entries are sorted from coarser resolution (highest scale denominator) |
| to most detailed resolution (lowest scale denominator). |
| |
| <p>The returned view is unmodifiable but live: creations or removals of tile matrices |
| in this set will be reflected on the returned map.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="TileMatrixSet.html#getTileMatrices()">getTileMatrices</a></code> in interface <code><a href="TileMatrixSet.html" title="interface in org.apache.sis.storage.tiling">TileMatrixSet</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable view of all <code>WritableTileMatrix</code> instances with their identifiers.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTileMatrix(org.apache.sis.storage.tiling.TileMatrix)"> |
| <h3>createTileMatrix</h3> |
| <div class="member-signature"><span class="return-type"><a href="WritableTileMatrix.html" title="interface in org.apache.sis.storage.tiling">WritableTileMatrix</a></span> <span class="element-name">createTileMatrix</span><wbr><span class="parameters">(<a href="TileMatrix.html" title="interface in org.apache.sis.storage.tiling">TileMatrix</a> tiles)</span> |
| throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div> |
| <div class="block">Adds the given tile matrix to this set and returns a writable instance for later completion. |
| Typically the given <a href="TileMatrix.html" title="interface in org.apache.sis.storage.tiling"><code>TileMatrix</code></a> instance contains no tile and is used only as a template. |
| If the <code>TileMatrix</code> is not empty, then the tiles that it contains are written immediately. |
| |
| <p>The <a href="TileMatrix.html#getTilingScheme()">tiling scheme</a> of the given tile matrix must |
| be compatible with this set. In particular, it must use the same CRS than the value returned |
| by <a href="TileMatrixSet.html#getCoordinateReferenceSystem()"><code>TileMatrixSet.getCoordinateReferenceSystem()</code></a>. If not, an <a href="../IncompatibleResourceException.html" title="class in org.apache.sis.storage"><code>IncompatibleResourceException</code></a> |
| is thrown.</p> |
| |
| <p>This method returns a writable tile matrix with the same tiles than the given <code>TileMatrix</code>. |
| However, the identifier of the returned tile matrix may be different.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tiles</code> - the (potentially empty) tile matrix to create.</dd> |
| <dt>Returns:</dt> |
| <dd>a writable tile matrix to use for adding more tiles.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../ReadOnlyStorageException.html" title="class in org.apache.sis.storage">ReadOnlyStorageException</a></code> - if this tile matrix set is not writable. It may be caused by insufficient credentials.</dd> |
| <dd><code><a href="../IncompatibleResourceException.html" title="class in org.apache.sis.storage">IncompatibleResourceException</a></code> - if the tiling scheme of the given tile matrix is not compatible with this set.</dd> |
| <dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if creating the tile matrix failed for another reason.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteTileMatrix(java.lang.String)"> |
| <h3>deleteTileMatrix</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">deleteTileMatrix</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> identifier)</span> |
| throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div> |
| <div class="block">Deletes a <code>TileMatrix</code> identified by the given name. The given identifier shall be the |
| <code><a href="TileMatrix.html#getIdentifier()">TileMatrix.getIdentifier()</a>.toString()</code> value of the tile matrix to delete.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>identifier</code> - identifier of the <a href="TileMatrix.html" title="interface in org.apache.sis.storage.tiling"><code>TileMatrix</code></a> to delete.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../NoSuchDataException.html" title="class in org.apache.sis.storage">NoSuchDataException</a></code> - if there is no tile matrix associated to the given identifier in this set.</dd> |
| <dd><code><a href="../ReadOnlyStorageException.html" title="class in org.apache.sis.storage">ReadOnlyStorageException</a></code> - if this tile matrix set is not writable. It may be caused by insufficient credentials.</dd> |
| <dd><code><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if deleting the tile matrix failed for another reason.</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> |
