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

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
 <title>JoinFeatureSet (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.aggregate, class: JoinFeatureSet">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.storage.aggregate.JoinFeatureSet class">
 <meta name="keywords" content="left">
 <meta name="keywords" content="right">
 <meta name="keywords" content="condition">
 <meta name="keywords" content="getJoinType()">
 <meta name="keywords" content="getType()">
 <meta name="keywords" content="features()">
 <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">&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="../../../../../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><a href="#field-summary">Field</a></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><a href="#field-detail">Field</a></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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.sis.storage</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage.aggregate</a></div>
 <h1 title="Class JoinFeatureSet" class="title">Class JoinFeatureSet</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/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="../AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a>
 <div class="inheritance"><a href="../AbstractFeatureSet.html" title="class in org.apache.sis.storage">AbstractFeatureSet</a>
 <div class="inheritance">JoinFeatureSet</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="../DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></code>, <code><a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</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 class </span><span class="element-name type-name-label">JoinFeatureSet</span>
 <span class="extends-implements">extends <a href="../AbstractFeatureSet.html" title="class in org.apache.sis.storage">AbstractFeatureSet</a></span></div>
 <div class="block">Features containing association to features from two different sources, joined by a SQL-like <code>JOIN</code> condition.
  Each feature in this <code>FeatureSet</code> contains two or three properties:

  <ul>
    <li>An optional identifier created from the identifiers of the left and right features.</li>
    <li>Zero or one association to a "left"  feature.</li>
    <li>Zero or one association to a "right" feature.</li>
  </ul>

  The left and right features appear together in an <code>JoinFeatureSet</code> instance when a value from
  <code>leftProperty</code> in the first feature is equal to a value from <code>rightProperty</code> in the second feature.

  <h2 id="implementation-note-heading">Implementation note</h2>
  If iterations in one feature set is cheaper than iterations in the other feature set, then the "costly" or larger
  <code>FeatureSet</code> should be on the left side and the "cheap" <code>FeatureSet</code> should be on the right side.

  <p>This implementation is read-only.</p></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.0</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">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="JoinFeatureSet.Type.html" class="type-name-link" title="enum class in org.apache.sis.storage.aggregate">JoinFeatureSet.Type</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Specifies whether values on both sides are required (inner join), or only one side (outer join).</div>
 </div>
 </div>
 </section>
 </li>
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</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">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>final BinaryComparisonOperator<wbr>&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;</code></div>
 <div class="col-second even-row-color"><code><a href="#condition" class="member-name-link">condition</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The join condition in the form <var>property from left feature</var> = <var>property from right feature</var>.</div>
 </div>
 <div class="col-first odd-row-color"><code>final <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#left" class="member-name-link">left</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">The first source of features.</div>
 </div>
 <div class="col-first even-row-color"><code>final <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></code></div>
 <div class="col-second even-row-color"><code><a href="#right" class="member-name-link">right</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The second source of features.</div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-AbstractResource">Fields inherited from class&nbsp;<a href="../AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></h3>
 <code><a href="../AbstractResource.html#listeners">listeners</a></code></div>
 </section>
 </li>
 <!-- ======== 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(org.apache.sis.storage.Resource,org.apache.sis.storage.FeatureSet,java.lang.String,org.apache.sis.storage.FeatureSet,java.lang.String,org.apache.sis.storage.aggregate.JoinFeatureSet.Type,org.apache.sis.pending.geoapi.filter.BinaryComparisonOperator,java.util.Map)" class="member-name-link">JoinFeatureSet</a><wbr>(<a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a>&nbsp;parent,
  <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a>&nbsp;left,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;leftAlias,
  <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a>&nbsp;right,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rightAlias,
  <a href="JoinFeatureSet.Type.html" title="enum class in org.apache.sis.storage.aggregate">JoinFeatureSet.Type</a>&nbsp;joinType,
  BinaryComparisonOperator&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;&nbsp;condition,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;featureInfo)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new feature set joining the two given sets.</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>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearCache()" class="member-name-link">clearCache</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Clears any cache in this resource, forcing the data to be recomputed when needed again.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMetadata()" class="member-name-link">createMetadata</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Invoked in a synchronized block the first time that <code>getMetadata()</code> is invoked.</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/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><wbr>&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#features(boolean)" class="member-name-link">features</a><wbr>(boolean&nbsp;parallel)</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 stream of all features contained in this dataset.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<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>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEnvelope()" class="member-name-link">getEnvelope</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 union of the envelopes in all aggregated feature sets.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JoinFeatureSet.Type.html" title="enum class in org.apache.sis.storage.aggregate">JoinFeatureSet.Type</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinType()" class="member-name-link">getJoinType</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Specifies whether values on both sides are required (inner join), or only one side (outer join).</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</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 a description of properties that are common to all features in this dataset.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-AbstractFeatureSet">Methods inherited from class&nbsp;<a href="../AbstractFeatureSet.html" title="class in org.apache.sis.storage">AbstractFeatureSet</a></h3>
 <code><a href="../AbstractFeatureSet.html#getFeatureCount()">getFeatureCount</a>, <a href="../AbstractFeatureSet.html#getIdentifier()">getIdentifier</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-AbstractResource">Methods inherited from class&nbsp;<a href="../AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></h3>
 <code><a href="../AbstractResource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">addListener</a>, <a href="../AbstractResource.html#getMetadata()">getMetadata</a>, <a href="../AbstractResource.html#getSynchronizationLock()">getSynchronizationLock</a>, <a href="../AbstractResource.html#removeListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">removeListener</a></code></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/11/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/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-FeatureSet">Methods inherited from interface&nbsp;<a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></h3>
 <code><a href="../FeatureSet.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&nbsp;<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#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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="left">
 <h3>left</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></span>&nbsp;<span class="element-name">left</span></div>
 <div class="block">The first source of features.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="right">
 <h3>right</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a></span>&nbsp;<span class="element-name">right</span></div>
 <div class="block">The second source of features.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="condition">
 <h3>condition</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">BinaryComparisonOperator&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;</span>&nbsp;<span class="element-name">condition</span></div>
 <div class="block">The join condition in the form <var>property from left feature</var> = <var>property from right feature</var>.
  This condition specifies also if the comparison is case
  sensitive and how to compare multi-values.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= 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;(org.apache.sis.storage.Resource,org.apache.sis.storage.FeatureSet,java.lang.String,org.apache.sis.storage.FeatureSet,java.lang.String,org.apache.sis.storage.aggregate.JoinFeatureSet.Type,org.apache.sis.pending.geoapi.filter.BinaryComparisonOperator,java.util.Map)">
 <h3>JoinFeatureSet</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">JoinFeatureSet</span><wbr><span class="parameters">(<a href="../Resource.html" title="interface in org.apache.sis.storage">Resource</a>&nbsp;parent,
  <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a>&nbsp;left,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;leftAlias,
  <a href="../FeatureSet.html" title="interface in org.apache.sis.storage">FeatureSet</a>&nbsp;right,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;rightAlias,
  <a href="JoinFeatureSet.Type.html" title="enum class in org.apache.sis.storage.aggregate">JoinFeatureSet.Type</a>&nbsp;joinType,
  BinaryComparisonOperator&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;&nbsp;condition,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;featureInfo)</span>
                throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
 <div class="block">Creates a new feature set joining the two given sets. The <code>featureInfo</code> map defines the name,
  description or other information for the <code>FeatureType</code> created by this method. It can contain all
  the properties described in <a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultFeatureType.html" title="class in org.apache.sis.feature"><code>DefaultFeatureType</code></a> plus the following ones:

  <ul>
    <li><code>"identifierDelimiter"</code> — string to insert between left and right identifiers in the identifiers
      generated by the join operation. If this property is not specified, then no identifier will be generated.</li>
    <li><code>"identifierPrefix"</code> — string to insert at the beginning of join identifiers (optional).</li>
    <li><code>"identifierSuffix"</code> — string to insert at the end of join identifiers (optional).</li>
  </ul></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>parent</code> - the parent resource, or <code>null</code> if none.</dd>
 <dd><code>left</code> - the first source of features. This is often (but not necessarily) the largest set.</dd>
 <dd><code>leftAlias</code> - name of the associations to the <code>left</code> features, or <code>null</code> for a default name.</dd>
 <dd><code>right</code> - the second source of features. Should be the set in which iterations are cheapest.</dd>
 <dd><code>rightAlias</code> - name of the associations to the <code>right</code> features, or <code>null</code> for a default name.</dd>
 <dd><code>joinType</code> - whether values on both sides are required (inner join), or only one side (outer join).</dd>
 <dd><code>condition</code> - join condition as <var>property from left feature</var> = <var>property from right feature</var>.</dd>
 <dd><code>featureInfo</code> - information about the <code>FeatureType</code> of this feature set.</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 creating the feature set.</dd>
 </dl>
 </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="getJoinType()">
 <h3>getJoinType</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="JoinFeatureSet.Type.html" title="enum class in org.apache.sis.storage.aggregate">JoinFeatureSet.Type</a></span>&nbsp;<span class="element-name">getJoinType</span>()</div>
 <div class="block">Specifies whether values on both sides are required (inner join), or only one side (outer join).</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>whether values on both sides are required (inner join), or only one side (outer join).</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getType()">
 <h3>getType</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a></span>&nbsp;<span class="element-name">getType</span>()</div>
 <div class="block">Returns a description of properties that are common to all features in this dataset.
  This type may contain one identifier and always contains two associations,
  to the <a href="#left">left</a> and <a href="#right"><code>right</code></a> set of features respectively.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>a description of properties that are common to all features in this dataset.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="features(boolean)">
 <h3>features</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a>&lt;<a href="../../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a>&gt;</span>&nbsp;<span class="element-name">features</span><wbr><span class="parameters">(boolean&nbsp;parallel)</span>
                                  throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
 <div class="block">Returns a stream of all features contained in this dataset.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>parallel</code> - <code>true</code> for a parallel stream (if supported), or <code>false</code> for a sequential stream.</dd>
 <dt>Returns:</dt>
 <dd>all features contained in this dataset.</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 creating the stream.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getEnvelope()">
 <h3>getEnvelope</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getEnvelope</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 union of the envelopes in all aggregated feature sets.
  This method tries to find a CRS common to all feature sets.
  If no common CRS can be found, then the envelope is absent.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../DataSet.html#getEnvelope()">getEnvelope</a></code>&nbsp;in interface&nbsp;<code><a href="../DataSet.html" title="interface in org.apache.sis.storage">DataSet</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="../AbstractResource.html#getEnvelope()">getEnvelope</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></code></dd>
 <dt>Returns:</dt>
 <dd>union of envelopes from all dependencies.</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 computing the envelope.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="createMetadata()">
 <h3>createMetadata</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link">Metadata</a></span>&nbsp;<span class="element-name">createMetadata</span>()
                            throws <span class="exceptions"><a href="../DataStoreException.html" title="class in org.apache.sis.storage">DataStoreException</a></span></div>
 <div class="block">Invoked in a synchronized block the first time that <code>getMetadata()</code> is invoked.
  The default implementation adds the information documented in the
  <a href="../AbstractFeatureSet.html#createMetadata()">parent class</a>,
  then adds the dependencies as lineages.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="../AbstractFeatureSet.html#createMetadata()">createMetadata</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractFeatureSet.html" title="class in org.apache.sis.storage">AbstractFeatureSet</a></code></dd>
 <dt>Returns:</dt>
 <dd>the newly created metadata, or <code>null</code> if unknown.</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 metadata from the data stores.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="clearCache()">
 <h3>clearCache</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clearCache</span>()</div>
 <div class="block">Clears any cache in this resource, forcing the data to be recomputed when needed again.
  This method should be invoked if the data in underlying data store changed.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="../AbstractResource.html#clearCache()">clearCache</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractResource.html" title="class in org.apache.sis.storage">AbstractResource</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>