org/apache/sis/storage/CoverageQuery.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>CoverageQuery (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, class: CoverageQuery">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.storage.CoverageQuery class">
 <meta name="keywords" content="setSelection()">
 <meta name="keywords" content="getSelection()">
 <meta name="keywords" content="setProjection()">
 <meta name="keywords" content="getProjection()">
 <meta name="keywords" content="setSourceDomainExpansion()">
 <meta name="keywords" content="getSourceDomainExpansion()">
 <meta name="keywords" content="execute()">
 <meta name="keywords" content="clone()">
 <meta name="keywords" content="hashCode()">
 <meta name="keywords" content="equals()">
 <meta name="keywords" content="toString()">
 <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">&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="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/CoverageQuery.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><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>Field&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="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage</a></div>
 <h1 title="Class CoverageQuery" class="title">Class CoverageQuery</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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="Query.html" title="class in org.apache.sis.storage">Query</a>
 <div class="inheritance">CoverageQuery</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/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CoverageQuery</span>
 <span class="extends-implements">extends <a href="Query.html" title="class in org.apache.sis.storage">Query</a>
 implements <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
 <div class="block">Definition of filtering to apply for fetching a subset of <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage"><code>GridCoverageResource</code></a>.
  This query allows requesting a subset of the coverage domain and the range.

  <h2>Terminology</h2>
  This class uses relational database terminology for consistency with generic queries:
  <ul>
    <li>A <cite>selection</cite> is a filter choosing the cells or pixels to include in the subset.
        In this context, the selection is the <cite>coverage domain</cite>.</li>
    <li>A <cite>projection</cite> (not to be confused with map projection) is the set of sample values to keep.
        In this context, the projection is the <cite>coverage range</cite> (i.e. set of sample dimensions).</li>
  </ul>

  <h2>Optional values</h2>
  All aspects of this query are optional and initialized to "none".
  Unless otherwise specified, all methods accept a null argument or can return a null value, which means "none".</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.1</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../serialized-form.html#org.apache.sis.storage.CoverageQuery">Serialized Form</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">
 <!-- ======== 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()" class="member-name-link">CoverageQuery</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new query performing no filtering.</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><a href="CoverageQuery.html" title="class in org.apache.sis.storage">CoverageQuery</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</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 a clone of this query.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Compares this query with the given object for equality.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(org.apache.sis.storage.GridCoverageResource)" class="member-name-link">execute</a><wbr>(<a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>&nbsp;source)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Applies this query on the given coverage resource.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProjection()" class="member-name-link">getProjection</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 indices of samples dimensions to read, or <code>null</code> if there is no filtering on range.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSelection()" class="member-name-link">getSelection</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 the desired grid extent and resolution.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceDomainExpansion()" class="member-name-link">getSourceDomainExpansion</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 number of additional cells to read on each border of the source grid coverage.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</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 a hash code value for this query.</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="#setProjection(int...)" class="member-name-link">setProjection</a><wbr>(int...&nbsp;range)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the indices of samples dimensions to read (the <cite>coverage range</cite>).</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setProjection(java.lang.String...)" class="member-name-link">setProjection</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>...&nbsp;range)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the sample dimensions to read by their names.</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="#setSelection(org.apache.sis.coverage.grid.GridGeometry)" class="member-name-link">setSelection</a><wbr>(<a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a>&nbsp;domain)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the desired grid extent and resolution.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSelection(org.opengis.geometry.Envelope)" class="member-name-link">setSelection</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a>&nbsp;domain)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the approximate area of cells or pixels to include in the subset.</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="#setSourceDomainExpansion(int)" class="member-name-link">setSourceDomainExpansion</a><wbr>(int&nbsp;margin)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets a number of additional cells to read on each border of the source grid coverage.</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/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</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 a textual representation of this query for debugging purposes.</div>
 </div>
 </div>
 </div>
 </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/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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>
 </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;()">
 <h3>CoverageQuery</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CoverageQuery</span>()</div>
 <div class="block">Creates a new query performing no filtering.</div>
 </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="setSelection(org.opengis.geometry.Envelope)">
 <h3>setSelection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSelection</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a>&nbsp;domain)</span></div>
 <div class="block">Sets the approximate area of cells or pixels to include in the subset.
  This convenience method creates a grid geometry containing only the given envelope.
  Note that the given envelope is approximate:
  Coverages may expand the envelope to an integer amount of tiles.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="Query.html#setSelection(org.opengis.geometry.Envelope)">setSelection</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.sis.storage">Query</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>domain</code> - the approximate area of interest, or <code>null</code> if none.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSelection(org.apache.sis.coverage.grid.GridGeometry)">
 <h3>setSelection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSelection</span><wbr><span class="parameters">(<a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a>&nbsp;domain)</span></div>
 <div class="block">Sets the desired grid extent and resolution. The given domain is approximate:
  Coverages may use a different resolution and expand the envelope to an integer amount of tiles.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>domain</code> - desired grid extent and resolution, or <code>null</code> for reading the whole domain.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSelection()">
 <h3>getSelection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../coverage/grid/GridGeometry.html" title="class in org.apache.sis.coverage.grid">GridGeometry</a></span>&nbsp;<span class="element-name">getSelection</span>()</div>
 <div class="block">Returns the desired grid extent and resolution.
  This is the value set by the last call to <a href="#setSelection(org.apache.sis.coverage.grid.GridGeometry)"><code>setSelection(GridGeometry)</code></a>.

  <div class="note"><b>Note on terminology:</b>
  "selection" is the generic term used in queries for designating a subset of feature instances.
  In a grid coverage, feature instances are cells or pixels.
  So this concept maps to the <cite>coverage domain</cite>.</div></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>desired grid extent and resolution, or <code>null</code> for reading the whole domain.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setProjection(java.lang.String...)">
 <h3>setProjection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setProjection</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>...&nbsp;range)</span></div>
 <div class="block">Sets the sample dimensions to read by their names.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="Query.html#setProjection(java.lang.String...)">setProjection</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.sis.storage">Query</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>range</code> - sample dimensions to retrieve, or <code>null</code> to retrieve all properties.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if a sample dimension is duplicated.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setProjection(int...)">
 <h3>setProjection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setProjection</span><wbr><span class="parameters">(int...&nbsp;range)</span></div>
 <div class="block">Sets the indices of samples dimensions to read (the <cite>coverage range</cite>).
  A <code>null</code> value means to read all sample dimensions (no filtering on range).
  If non-null, then the <code>range</code> array shall contain at least one element,
  all elements must be positive and no value can be duplicated.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>range</code> - 0-based indices of sample dimensions to read, or <code>null</code> for reading them all.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given array is empty or contains negative or duplicated values.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getProjection()">
 <h3>getProjection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int[]</span>&nbsp;<span class="element-name">getProjection</span>()</div>
 <div class="block">Returns the indices of samples dimensions to read, or <code>null</code> if there is no filtering on range.
  If non-null, the returned array shall never be empty.

  <div class="note"><b>Note on terminology:</b>
  "projection" (not to be confused with map projection) is the generic term used in queries
  for designating a subset of feature properties retained in each feature instances.
  In a coverage, this concept maps to the <cite>coverage range</cite>.</div></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>0-based indices of sample dimensions to read, or <code>null</code> for reading them all.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSourceDomainExpansion(int)">
 <h3>setSourceDomainExpansion</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSourceDomainExpansion</span><wbr><span class="parameters">(int&nbsp;margin)</span></div>
 <div class="block">Sets a number of additional cells to read on each border of the source grid coverage.
  If non-zero, this property expands the <a href="#getSelection()"><code>domain</code></a> to be read
  by the specified margin.

  <h4>Unit of measurement</h4>
  The parameter value is a number of cells in the <code>domain</code> argument specified
  in a <a href="GridCoverageResource.html#read(org.apache.sis.coverage.grid.GridGeometry,int...)">read operation</a>.
  If no <code>domain</code> is specified at read time, then this is a number of cells in
  the full image to be read from the resource. Cells are counted after subsampling,
  e.g. cells are twice bigger if a subsampling of 2 is applied.
  Those cells do not necessarily have the same size than the cells
  of the <a href="#getSelection()"><code>domain of this query</code></a>.

  <h4>Use case</h4>
  At reading time it may be necessary to add a margin to the coverage extent.
  This margin is used when the user knows that an image processing operation
  will need to iterate over a little bit more data than the area of interest.
  For example, the bilinear interpolation uses a 2×2 pixels window.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>margin</code> - read margin, which must be zero or positive.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSourceDomainExpansion()">
 <h3>getSourceDomainExpansion</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getSourceDomainExpansion</span>()</div>
 <div class="block">Returns the number of additional cells to read on each border of the source grid coverage.
  This is the value sets by the last call to <a href="#setSourceDomainExpansion(int)"><code>setSourceDomainExpansion(int)</code></a>.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>read margin, zero or positive.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="execute(org.apache.sis.storage.GridCoverageResource)">
 <h3>execute</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a></span>&nbsp;<span class="element-name">execute</span><wbr><span class="parameters">(<a href="GridCoverageResource.html" title="interface in org.apache.sis.storage">GridCoverageResource</a>&nbsp;source)</span>
                                 throws <span class="exceptions"><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
 <div class="block">Applies this query on the given coverage resource.
  This method is invoked by the default implementation of <a href="GridCoverageResource.html#subset(org.apache.sis.storage.Query)"><code>GridCoverageResource.subset(Query)</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>source</code> - the coverage resource to filter.</dd>
 <dt>Returns:</dt>
 <dd>a view over the given coverage resource containing only the given domain and range.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></code> - if an error occurred during creation of the subset.</dd>
 <dt>Since:</dt>
 <dd>1.2</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="GridCoverageResource.html#subset(org.apache.sis.storage.Query)"><code>GridCoverageResource.subset(CoverageQuerty)</code></a></li>
 <li><a href="FeatureQuery.html#execute(org.apache.sis.storage.FeatureSet)"><code>FeatureQuery.execute(FeatureSet)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="clone()">
 <h3>clone</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CoverageQuery.html" title="class in org.apache.sis.storage">CoverageQuery</a></span>&nbsp;<span class="element-name">clone</span>()</div>
 <div class="block">Returns a clone of this query.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 <dt>Returns:</dt>
 <dd>a clone of this query.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="hashCode()">
 <h3>hashCode</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
 <div class="block">Returns a hash code value for this query.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 <dt>Returns:</dt>
 <dd>a hash value for this query.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equals(java.lang.Object)">
 <h3>equals</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</span></div>
 <div class="block">Compares this query with the given object for equality.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>obj</code> - the object to compare with this query.</dd>
 <dt>Returns:</dt>
 <dd>whether the two objects are equal.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">toString</span>()</div>
 <div class="block">Returns a textual representation of this query for debugging purposes.
  The default implementation returns a string that looks like an SQL Select query.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 <dt>Returns:</dt>
 <dd>textual representation of this query.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>