| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>QueryIterator (Apache Jena ARQ)</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: module: org.apache.jena.arq, package: org.apache.jena.sparql.engine, interface: QueryIterator"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.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.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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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"> |
| <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="../../../../../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="class-use/QueryIterator.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> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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.jena.arq</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.sparql.engine</a></div> |
| <h1 title="Interface QueryIterator" class="title">Interface QueryIterator</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>org.apache.jena.atlas.lib.Closeable</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>></code>, <code>org.apache.jena.atlas.iterator.IteratorCloseable<<a href="binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>></code>, <code>org.apache.jena.atlas.io.Printable</code>, <code><a href="../util/PrintSerializable.html" title="interface in org.apache.jena.sparql.util">PrintSerializable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="join/AbstractIterHashJoin.html" title="class in org.apache.jena.sparql.engine.join">AbstractIterHashJoin</a></code>, <code><a href="iterator/QueryIter.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter</a></code>, <code><a href="iterator/QueryIter1.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter1</a></code>, <code><a href="iterator/QueryIter2.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter2</a></code>, <code><a href="iterator/QueryIter2LoopOnLeft.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter2LoopOnLeft</a></code>, <code><a href="iterator/QueryIterAbortable.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterAbortable</a></code>, <code><a href="iterator/QueryIterAddTripleTerm.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterAddTripleTerm</a></code>, <code><a href="iterator/QueryIterAssign.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterAssign</a></code>, <code><a href="iterator/QueryIterAssignVarValue.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterAssignVarValue</a></code>, <code><a href="iterator/QueryIteratorBase.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorBase</a></code>, <code><a href="iterator/QueryIteratorCaching.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorCaching</a></code>, <code><a href="iterator/QueryIteratorCheck.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorCheck</a></code>, <code><a href="iterator/QueryIteratorCloseable.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorCloseable</a></code>, <code><a href="iterator/QueryIteratorLogging.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorLogging</a></code>, <code><a href="iterator/QueryIteratorMapped.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorMapped</a></code>, <code><a href="iterator/QueryIteratorResultSet.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorResultSet</a></code>, <code><a href="iterator/QueryIteratorTiming.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorTiming</a></code>, <code><a href="iterator/QueryIteratorWrapper.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorWrapper</a></code>, <code><a href="iterator/QueryIterCommonParent.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterCommonParent</a></code>, <code><a href="iterator/QueryIterConcat.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterConcat</a></code>, <code><a href="iterator/QueryIterConvert.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterConvert</a></code>, <code><a href="iterator/QueryIterDefaulting.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDefaulting</a></code>, <code><a href="iterator/QueryIterDiff.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDiff</a></code>, <code><a href="iterator/QueryIterDistinct.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDistinct</a></code>, <code><a href="iterator/QueryIterDistinctMem.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDistinctMem</a></code>, <code><a href="iterator/QueryIterDistinctReduced.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDistinctReduced</a></code>, <code><a href="iterator/QueryIterDistinguishedVars.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterDistinguishedVars</a></code>, <code><a href="iterator/QueryIterExtendByVar.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterExtendByVar</a></code>, <code><a href="iterator/QueryIterFilterExpr.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterFilterExpr</a></code>, <code><a href="main/iterator/QueryIterGraph.html" title="class in org.apache.jena.sparql.engine.main.iterator">QueryIterGraph</a></code>, <code><a href="iterator/QueryIterGroup.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterGroup</a></code>, <code><a href="join/QueryIterHashJoin.html" title="class in org.apache.jena.sparql.engine.join">QueryIterHashJoin</a></code>, <code><a href="join/QueryIterHashLeftJoin_Left.html" title="class in org.apache.jena.sparql.engine.join">QueryIterHashLeftJoin_Left</a></code>, <code><a href="join/QueryIterHashLeftJoin_Right.html" title="class in org.apache.jena.sparql.engine.join">QueryIterHashLeftJoin_Right</a></code>, <code><a href="iterator/QueryIterLateral.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterLateral</a></code>, <code><a href="iterator/QueryIterMinus.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterMinus</a></code>, <code><a href="join/QueryIterNestedLoopJoin.html" title="class in org.apache.jena.sparql.engine.join">QueryIterNestedLoopJoin</a></code>, <code><a href="join/QueryIterNestedLoopLeftJoin.html" title="class in org.apache.jena.sparql.engine.join">QueryIterNestedLoopLeftJoin</a></code>, <code><a href="iterator/QueryIterNullIterator.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterNullIterator</a></code>, <code><a href="main/iterator/QueryIterOptionalIndex.html" title="class in org.apache.jena.sparql.engine.main.iterator">QueryIterOptionalIndex</a></code>, <code><a href="iterator/QueryIterPath.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterPath</a></code>, <code><a href="iterator/QueryIterPeek.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterPeek</a></code>, <code><a href="iterator/QueryIterPlainWrapper.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterPlainWrapper</a></code>, <code><a href="iterator/QueryIterProcedure.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterProcedure</a></code>, <code><a href="iterator/QueryIterProcessBinding.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterProcessBinding</a></code>, <code><a href="iterator/QueryIterProject.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterProject</a></code>, <code><a href="iterator/QueryIterProjectMerge.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterProjectMerge</a></code>, <code><a href="iterator/QueryIterReduced.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterReduced</a></code>, <code><a href="iterator/QueryIterRepeatApply.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterRepeatApply</a></code>, <code><a href="iterator/QueryIterRoot.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterRoot</a></code>, <code><a href="main/iterator/QueryIterService.html" title="class in org.apache.jena.sparql.engine.main.iterator">QueryIterService</a></code>, <code><a href="iterator/QueryIterSingleton.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterSingleton</a></code>, <code><a href="iterator/QueryIterSlice.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterSlice</a></code>, <code><a href="iterator/QueryIterSort.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterSort</a></code>, <code><a href="iterator/QueryIterSub.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterSub</a></code>, <code><a href="iterator/QueryIterTopN.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterTopN</a></code>, <code><a href="iterator/QueryIterTracked.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterTracked</a></code>, <code><a href="main/iterator/QueryIterUnion.html" title="class in org.apache.jena.sparql.engine.main.iterator">QueryIterUnion</a></code>, <code><a href="iterator/QueryIterYieldN.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIterYieldN</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryIterator</span><span class="extends-implements"> |
| extends org.apache.jena.atlas.iterator.IteratorCloseable<<a href="binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>>, <a href="../util/PrintSerializable.html" title="interface in org.apache.jena.sparql.util">PrintSerializable</a></span></div> |
| <div class="block">Root of query iterators in ARQ.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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="#cancel()" class="member-name-link">cancel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Cancels the query as soon as is possible for the given iterator</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isJoinIdentity()" class="member-name-link">isJoinIdentity</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextBinding()" class="member-name-link">nextBinding</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get next binding</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.jena.atlas.lib.Closeable">Methods inherited from interface org.apache.jena.atlas.lib.Closeable</h3> |
| <code>close</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.util.Iterator">Methods inherited from interface java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#forEachRemaining(java.util.function.Consumer)" title="class or interface in java.util" class="external-link">forEachRemaining</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#hasNext()" title="class or interface in java.util" class="external-link">hasNext</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#next()" title="class or interface in java.util" class="external-link">next</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#remove()" title="class or interface in java.util" class="external-link">remove</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.jena.atlas.io.Printable">Methods inherited from interface org.apache.jena.atlas.io.Printable</h3> |
| <code>output</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.jena.sparql.util.PrintSerializable">Methods inherited from interface org.apache.jena.sparql.util.<a href="../util/PrintSerializable.html" title="interface in org.apache.jena.sparql.util">PrintSerializable</a></h3> |
| <code><a href="../util/PrintSerializable.html#output(org.apache.jena.atlas.io.IndentedWriter,org.apache.jena.sparql.serializer.SerializationContext)">output</a>, <a href="../util/PrintSerializable.html#toString(org.apache.jena.shared.PrefixMapping)">toString</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="nextBinding()"> |
| <h3>nextBinding</h3> |
| <div class="member-signature"><span class="return-type"><a href="binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a></span> <span class="element-name">nextBinding</span>()</div> |
| <div class="block">Get next binding</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cancel()"> |
| <h3>cancel</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">cancel</span>()</div> |
| <div class="block">Cancels the query as soon as is possible for the given iterator</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJoinIdentity()"> |
| <h3>isJoinIdentity</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isJoinIdentity</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
