| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>WritableGridCoverageResource (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, package: org.apache.sis.storage, interface: WritableGridCoverageResource"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.storage.WritableGridCoverageResource interface"> |
| <meta name="keywords" content="write()"> |
| <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"> </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="../../../../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><a href="#nested-class-summary">Nested</a></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><a href="#nested-class-summary">Nested</a> | </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="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.storage</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.storage</a></div> |
| <h1 title="Interface WritableGridCoverageResource" class="title">Interface WritableGridCoverageResource</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></code>, <code><a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></code>, <code><a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WritableGridCoverageResource</span><span class="extends-implements"> |
| extends <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></span></div> |
| <div class="block">A <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage"><code>GridCoverageResource</code></a> with writing capabilities. <code>WritableGridCoverageResource</code> inherits the reading |
| capabilities from its parent and adds a <a href="#write(org.apache.sis.coverage.grid.GridCoverage,org.apache.sis.storage.WritableGridCoverageResource.Option...)">write</a> operation. Some aspects of the write operation can |
| be controlled by options, which may be <a href="DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a>-specific.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="WritableGridCoverageResource.CommonOption.html" class="type-name-link" title="enum class in org.apache.sis.storage">WritableGridCoverageResource.CommonOption</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Write options that may apply to any data store.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="WritableGridCoverageResource.Option.html" class="type-name-link" title="interface in org.apache.sis.storage">WritableGridCoverageResource.Option</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration of the process of writing a coverage in a data store.</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-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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#write(org.apache.sis.coverage.grid.GridCoverage,org.apache.sis.storage.WritableGridCoverageResource.Option...)" class="member-name-link">write</a><wbr>(<a href="../../../../../org.apache.sis.feature/org/apache/sis/coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a> coverage, |
| <a href="WritableGridCoverageResource.Option.html" title="interface in org.apache.sis.storage">WritableGridCoverageResource.Option</a>... options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a new coverage in the data store for this resource.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-DataSet">Methods inherited from interface <a href="DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></h3> |
| <code><a href="DataSet.html#getEnvelope()">getEnvelope</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-GridCoverageResource">Methods inherited from interface <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></h3> |
| <code><a href="GridCoverageResource.html#getGridGeometry()">getGridGeometry</a>, <a href="GridCoverageResource.html#getLoadingStrategy()">getLoadingStrategy</a>, <a href="GridCoverageResource.html#getResolutions()">getResolutions</a>, <a href="GridCoverageResource.html#getSampleDimensions()">getSampleDimensions</a>, <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)">read</a>, <a href="GridCoverageResource.html#setLoadingStrategy(org.apache.sis.storage.RasterLoadingStrategy)">setLoadingStrategy</a>, <a href="GridCoverageResource.html#subset(org.apache.sis.storage.Query)">subset</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Resource">Methods inherited from interface <a href="Resource.html" title="interface in org.apache.sis.storage">Resource</a></h3> |
| <code><a href="Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a>, <a href="Resource.html#getIdentifier()">getIdentifier</a>, <a href="Resource.html#getMetadata()">getMetadata</a>, <a href="Resource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</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="write(org.apache.sis.coverage.grid.GridCoverage,org.apache.sis.storage.WritableGridCoverageResource.Option...)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">write</span><wbr><span class="parameters">(<a href="../../../../../org.apache.sis.feature/org/apache/sis/coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid">GridCoverage</a> coverage, |
| <a href="WritableGridCoverageResource.Option.html" title="interface in org.apache.sis.storage">WritableGridCoverageResource.Option</a>... options)</span> |
| throws <span class="exceptions"><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div> |
| <div class="block">Writes a new coverage in the data store for this resource. If a coverage already exists for this resource, |
| then the behavior of this method is determined by the given options. If no option is specified, the default |
| behavior is to fail if writing a coverage would cause an existing coverage to be overwritten. |
| This behavior can be modified by requesting the <a href="WritableGridCoverageResource.CommonOption.html#REPLACE"><code>replacement</code></a> |
| or <a href="WritableGridCoverageResource.CommonOption.html#UPDATE">update</a> of existing coverages.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>coverage</code> - new data to write in the data store for this resource.</dd> |
| <dd><code>options</code> - configuration of the write operation. May be <a href="DataStore.html" title="class in org.apache.sis.storage"><code>DataStore</code></a>-specific options |
| (e.g. for compression, encryption, <i>etc</i>).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if mutually exclusive options are specified.</dd> |
| <dd><code><a href="ReadOnlyStorageException.html" title="class in org.apache.sis.storage">ReadOnlyStorageException</a></code> - if the resource is (possibly temporarily) read-only.</dd> |
| <dd><code><a href="ResourceAlreadyExistsException.html" title="class in org.apache.sis.storage">ResourceAlreadyExistsException</a></code> - if a coverage already exists in this resource |
| and no <code>REPLACE</code> or <code>UPDATE</code> option have been specified.</dd> |
| <dd><code><a href="IncompatibleResourceException.html" title="class in org.apache.sis.storage">IncompatibleResourceException</a></code> - if the given resource cannot be written, |
| for example because its grid geometry is unsupported by this resource.</dd> |
| <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if another error occurred while writing data in the underlying data store.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
