blob: d6ebc8b62b03dee70de3381e6d6da4cb448ad561 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>QueryIterProcedure (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.iterator, class: QueryIterProcedure">
<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 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/QueryIterProcedure.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:&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>Method</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>&nbsp;<a href="../../../../../../module-summary.html">org.apache.jena.arq</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.sparql.engine.iterator</a></div>
<h1 title="Class QueryIterProcedure" class="title">Class QueryIterProcedure</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../../util/PrintSerializableBase.html" title="class in org.apache.jena.sparql.util">org.apache.jena.sparql.util.PrintSerializableBase</a>
<div class="inheritance"><a href="QueryIteratorBase.html" title="class in org.apache.jena.sparql.engine.iterator">org.apache.jena.sparql.engine.iterator.QueryIteratorBase</a>
<div class="inheritance"><a href="QueryIter.html" title="class in org.apache.jena.sparql.engine.iterator">org.apache.jena.sparql.engine.iterator.QueryIter</a>
<div class="inheritance"><a href="QueryIter1.html" title="class in org.apache.jena.sparql.engine.iterator">org.apache.jena.sparql.engine.iterator.QueryIter1</a>
<div class="inheritance">org.apache.jena.sparql.engine.iterator.QueryIterProcedure</div>
</div>
</div>
</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/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>&gt;</code>, <code>org.apache.jena.atlas.io.Printable</code>, <code>org.apache.jena.atlas.iterator.IteratorCloseable&lt;<a href="../binding/Binding.html" title="interface in org.apache.jena.sparql.engine.binding">Binding</a>&gt;</code>, <code>org.apache.jena.atlas.lib.Closeable</code>, <code><a href="../QueryIterator.html" title="interface in org.apache.jena.sparql.engine">QueryIterator</a></code>, <code><a href="../../util/PrintSerializable.html" title="interface in org.apache.jena.sparql.util">PrintSerializable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QueryIterProcedure</span>
<span class="extends-implements">extends <a href="QueryIter1.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter1</a></span></div>
<div class="block">QueryIterator for a procedure. Delays first touch until first call because
first touch may cause work to be done.
Assumes .build already called.</div>
</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(org.apache.jena.sparql.engine.QueryIterator,org.apache.jena.sparql.procedure.Procedure,org.apache.jena.sparql.engine.ExecutionContext)" class="member-name-link">QueryIterProcedure</a><wbr>(<a href="../QueryIterator.html" title="interface in org.apache.jena.sparql.engine">QueryIterator</a>&nbsp;input,
<a href="../../procedure/Procedure.html" title="interface in org.apache.jena.sparql.procedure">Procedure</a>&nbsp;proc,
<a href="../ExecutionContext.html" title="class in org.apache.jena.sparql.engine">ExecutionContext</a>&nbsp;execCxt)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.engine.iterator.QueryIter1">Methods inherited from class&nbsp;org.apache.jena.sparql.engine.iterator.<a href="QueryIter1.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter1</a></h3>
<code><a href="QueryIter1.html#output(org.apache.jena.atlas.io.IndentedWriter,org.apache.jena.sparql.serializer.SerializationContext)">output</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.engine.iterator.QueryIter">Methods inherited from class&nbsp;org.apache.jena.sparql.engine.iterator.<a href="QueryIter.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIter</a></h3>
<code><a href="QueryIter.html#close()">close</a>, <a href="QueryIter.html#flatMap(org.apache.jena.sparql.engine.QueryIterator,java.util.function.Function,org.apache.jena.sparql.engine.ExecutionContext)">flatMap</a>, <a href="QueryIter.html#getExecContext()">getExecContext</a>, <a href="QueryIter.html#getIteratorNumber()">getIteratorNumber</a>, <a href="QueryIter.html#makeTracked(org.apache.jena.sparql.engine.QueryIterator,org.apache.jena.sparql.engine.ExecutionContext)">makeTracked</a>, <a href="QueryIter.html#map(org.apache.jena.sparql.engine.QueryIterator,java.util.Map)">map</a>, <a href="QueryIter.html#materialize(org.apache.jena.sparql.engine.QueryIterator)">materialize</a>, <a href="QueryIter.html#materialize(org.apache.jena.sparql.engine.QueryIterator,org.apache.jena.sparql.engine.ExecutionContext)">materialize</a>, <a href="QueryIter.html#output(org.apache.jena.atlas.io.IndentedWriter)">output</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.engine.iterator.QueryIteratorBase">Methods inherited from class&nbsp;org.apache.jena.sparql.engine.iterator.<a href="QueryIteratorBase.html" title="class in org.apache.jena.sparql.engine.iterator">QueryIteratorBase</a></h3>
<code><a href="QueryIteratorBase.html#cancel()">cancel</a>, <a href="QueryIteratorBase.html#hasNext()">hasNext</a>, <a href="QueryIteratorBase.html#next()">next</a>, <a href="QueryIteratorBase.html#nextBinding()">nextBinding</a>, <a href="QueryIteratorBase.html#remove()">remove</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.util.PrintSerializableBase">Methods inherited from class&nbsp;org.apache.jena.sparql.util.<a href="../../util/PrintSerializableBase.html" title="class in org.apache.jena.sparql.util">PrintSerializableBase</a></h3>
<code><a href="../../util/PrintSerializableBase.html#toString()">toString</a>, <a href="../../util/PrintSerializableBase.html#toString(org.apache.jena.shared.PrefixMapping)">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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-java.util.Iterator">Methods inherited from interface&nbsp;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></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.util.PrintSerializable">Methods inherited from interface&nbsp;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#toString(org.apache.jena.shared.PrefixMapping)">toString</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.engine.QueryIterator">Methods inherited from interface&nbsp;org.apache.jena.sparql.engine.<a href="../QueryIterator.html" title="interface in org.apache.jena.sparql.engine">QueryIterator</a></h3>
<code><a href="../QueryIterator.html#isJoinIdentity()">isJoinIdentity</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;(org.apache.jena.sparql.engine.QueryIterator,org.apache.jena.sparql.procedure.Procedure,org.apache.jena.sparql.engine.ExecutionContext)">
<h3>QueryIterProcedure</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QueryIterProcedure</span><wbr><span class="parameters">(<a href="../QueryIterator.html" title="interface in org.apache.jena.sparql.engine">QueryIterator</a>&nbsp;input,
<a href="../../procedure/Procedure.html" title="interface in org.apache.jena.sparql.procedure">Procedure</a>&nbsp;proc,
<a href="../ExecutionContext.html" title="class in org.apache.jena.sparql.engine">ExecutionContext</a>&nbsp;execCxt)</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>