| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.filter (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.feature, package: org.apache.sis.filter"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.filter package"> |
| <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="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li>Related Packages</li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li>Related Packages | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../module-summary.html">org.apache.sis.feature</a></div> |
| <h1 title="Package org.apache.sis.filter" class="title">Package org.apache.sis.filter</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.filter</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Filters features according their properties. |
| A <cite>filter expression</cite> is a construct used to constraint a feature set to a subset. |
| Operations in this package follow the rules of |
| <a href="http://docs.opengeospatial.org/is/09-026r2/09-026r2.html">OGC® Filter Encoding</a> and |
| <a href="https://www.iso.org/standard/60343.html">ISO 13249-3 - SQLMM</a> standards. |
| |
| <h2 id="coordinate-reference-system-handling-heading">Coordinate reference system handling</h2> |
| Filters and expressions may contain heterogeneous coordinate reference systems. |
| Apache SIS tries to handle differences in the following way: |
| <ul> |
| <li>If at least one geometry does not has a CRS, then SIS assumes that the geometries are in the same space.</li> |
| <li>If all geometries are in the same CRS, no coordinate operation is applied.</li> |
| <li>If geometries have non-null but different CRS, then SIS tries to project the geometries in a common space: |
| <ul> |
| <li>For SQLMM operations, the CRS of the first operand is used (as required by the specification).</li> |
| <li>For other operations, the common CRS is chosen by |
| <a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/CRS.html#suggestCommonTarget(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.referencing.crs.CoordinateReferenceSystem...)">referencing utility method</a>. |
| If that method cannot provide a common space, |
| then an <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"><code>IllegalArgumentException</code></a> is thrown.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h2 id="performance-tips-heading">Performance tips</h2> |
| <p>In expressions like <code>ST_Intersects(A,B)</code> where the <var>A</var> and <var>B</var> parameters are two |
| sub-expressions evaluating to geometry values, if one of those expressions is a literal, then that literal |
| should be <var>B</var>. The reason is because SQLMM specification requires us to project <var>B</var> |
| in the Coordinate Reference System of <var>A</var>. If <var>B</var> is a literal, Apache SIS can do |
| this transformation only once before to start any evaluation instead of every time that the expression |
| needs to be evaluated.</p> |
| |
| <p>Data store implementations should apply <a href="Optimization.html" title="class in org.apache.sis.filter"><code>Optimization</code></a> on the filters |
| before to evaluate them.</p> |
| |
| <h2 id="thread-safety-heading">Thread-safety</h2> |
| All filter and expression implementations provided by Apache SIS are thread-safe. |
| They are not necessarily stateless however; for example a filter may remember which |
| warnings have been reported in order to avoid to report the same warning twice.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DefaultFilterFactory.html" title="class in org.apache.sis.filter">DefaultFilterFactory</a><R,<wbr>G,<wbr>T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A factory of default <a href="Filter.html" title="interface in org.apache.sis.filter"><code>Filter</code></a> and <a href="Expression.html" title="interface in org.apache.sis.filter"><code>Expression</code></a> implementations.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultFilterFactory.Features.html" title="class in org.apache.sis.filter">DefaultFilterFactory.Features</a><G,<wbr>T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A filter factory operating on <a href="../feature/AbstractFeature.html" title="class in org.apache.sis.feature"><code>AbstractFeature</code></a> instances.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Expression.html" title="interface in org.apache.sis.filter">Expression</a><R,<wbr>V></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A literal or a named procedure that performs a distinct computation.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Filter.html" title="interface in org.apache.sis.filter">Filter</a><R></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Identification of a subset of resources from a collection of resources |
| whose property values satisfy a set of logically connected predicates.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Optimization.html" title="class in org.apache.sis.filter">Optimization</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Description of optimizations or simplifications to attempt on filters and expressions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Optimization.OnExpression.html" title="interface in org.apache.sis.filter">Optimization.OnExpression</a><R,<wbr>V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Expression that can be optimized.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Optimization.OnFilter.html" title="interface in org.apache.sis.filter">Optimization.OnFilter</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Filter that can be optimized.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
