blob: 7d138b274735882ebe88dd0fa57d2d82ec18542c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>QueryExecutionAdapter (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.exec, class: QueryExecutionAdapter">
<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/QueryExecutionAdapter.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>Constr&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>Constr&nbsp;|&nbsp;</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>&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.exec</a></div>
<h1 title="Class QueryExecutionAdapter" class="title">Class QueryExecutionAdapter</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">org.apache.jena.sparql.exec.QueryExecutionAdapter</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/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="QueryExecutionCompat.html" title="class in org.apache.jena.sparql.exec">QueryExecutionCompat</a></code>, <code><a href="http/QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTP</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QueryExecutionAdapter</span>
<span class="extends-implements">extends <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>
implements <a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></span></div>
<div class="block">QueryExecution for a QueryExec working at the Graph-Node-Triple level.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query"><code>QueryExecution</code></a></li>
</ul>
</dd>
</dl>
</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abort()" class="member-name-link">abort</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Stop in mid execution.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#adapt(org.apache.jena.sparql.exec.QueryExec)" class="member-name-link">adapt</a><wbr>(<a href="QueryExec.html" title="interface in org.apache.jena.sparql.exec">QueryExec</a>&nbsp;qExec)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</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="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Close the query execution and stop query evaluation as soon as convenient.</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="#execAsk()" class="member-name-link">execAsk</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute an ASK query</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.rdf.model.Model</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execConstruct()" class="member-name-link">execConstruct</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.rdf.model.Model</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execConstruct(org.apache.jena.rdf.model.Model)" class="member-name-link">execConstruct</a><wbr>(org.apache.jena.rdf.model.Model&nbsp;model)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query, putting the statements into a graph.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execConstructDataset()" class="member-name-link">execConstructDataset</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query, putting the statements into 'dataset'.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execConstructDataset(org.apache.jena.query.Dataset)" class="member-name-link">execConstructDataset</a><wbr>(<a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a>&nbsp;dataset)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query, putting the statements into 'dataset'.</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/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../core/Quad.html" title="class in org.apache.jena.sparql.core">Quad</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="#execConstructQuads()" class="member-name-link">execConstructQuads</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query, returning the results as an iterator of <a href="../core/Quad.html" title="class in org.apache.jena.sparql.core"><code>Quad</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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;org.apache.jena.graph.Triple&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execConstructTriples()" class="member-name-link">execConstructTriples</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a CONSTRUCT query, returning the results as an iterator of <code>Triple</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.rdf.model.Model</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execDescribe()" class="member-name-link">execDescribe</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a DESCRIBE query</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.rdf.model.Model</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execDescribe(org.apache.jena.rdf.model.Model)" class="member-name-link">execDescribe</a><wbr>(org.apache.jena.rdf.model.Model&nbsp;model)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a DESCRIBE query, putting the statements into a graph.</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/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;org.apache.jena.graph.Triple&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execDescribeTriples()" class="member-name-link">execDescribeTriples</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a DESCRIBE query, returning the results as an iterator of <code>Triple</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../atlas/json/JsonArray.html" title="class in org.apache.jena.atlas.json">JsonArray</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execJson()" class="member-name-link">execJson</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a JSON query and return a json array</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/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../../atlas/json/JsonObject.html" title="class in org.apache.jena.atlas.json">JsonObject</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="#execJsonItems()" class="member-name-link">execJsonItems</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a JSON query and return an iterator</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../query/ResultSet.html" title="interface in org.apache.jena.query">ResultSet</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execSelect()" class="member-name-link">execSelect</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Execute a SELECT query</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The properties associated with a query execution -
implementation specific parameters This includes
Java objects (so it is not an RDF graph).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataset()" class="member-name-link">getDataset</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The dataset against which the query will execute.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../query/Query.html" title="class in org.apache.jena.query">Query</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuery()" class="member-name-link">getQuery</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The query associated with a query execution.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueryString()" class="member-name-link">getQueryString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The query as a string.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeout1()" class="member-name-link">getTimeout1</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the first timeout (time to first result), in milliseconds: negative if unset</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeout2()" class="member-name-link">getTimeout2</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the second timeout (overall query execution after first result), in milliseconds: negative if unset</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Answer whether this QueryExecution object has been closed or not.</div>
</div>
</div>
</div>
</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#toString()" title="class or interface in java.lang" class="external-link">toString</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>
</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="adapt(org.apache.jena.sparql.exec.QueryExec)">
<h3>adapt</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></span>&nbsp;<span class="element-name">adapt</span><wbr><span class="parameters">(<a href="QueryExec.html" title="interface in org.apache.jena.sparql.exec">QueryExec</a>&nbsp;qExec)</span></div>
</section>
</li>
<li>
<section class="detail" id="getDataset()">
<h3>getDataset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></span>&nbsp;<span class="element-name">getDataset</span>()</div>
<div class="block">The dataset against which the query will execute.
May be null, implying it is expected that the query itself
has a dataset description.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getDataset()">getDataset</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContext()">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a></span>&nbsp;<span class="element-name">getContext</span>()</div>
<div class="block">The properties associated with a query execution -
implementation specific parameters This includes
Java objects (so it is not an RDF graph).
Keys should be URIs as strings.
May be null (this implementation does not provide any configuration).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getContext()">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getQuery()">
<h3>getQuery</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../query/Query.html" title="class in org.apache.jena.query">Query</a></span>&nbsp;<span class="element-name">getQuery</span>()</div>
<div class="block">The query associated with a query execution.
May be null (QueryExecution may have been created by other means)</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getQuery()">getQuery</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getQueryString()">
<h3>getQueryString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">getQueryString</span>()</div>
<div class="block">The query as a string.
This may be null (QueryExec may have been created by other means).
This may contain non-Jena extensions and can not be parsed by Jena.
If <code>getQuery()</code> is not null, this is a corresponding string that parses to the same query.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getQueryString()">getQueryString</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execSelect()">
<h3>execSelect</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../query/ResultSet.html" title="interface in org.apache.jena.query">ResultSet</a></span>&nbsp;<span class="element-name">execSelect</span>()</div>
<div class="block">Execute a SELECT query
<p>
<strong>Important:</strong> The name of this method is somewhat of a misnomer in that
depending on the underlying implementation this typically does not execute the
SELECT query but rather answers a wrapper over an internal data structure that can be
used to answer the query. In essence calling this method only returns a plan for
executing this query which only gets evaluated when you actually start iterating
over the results.
</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execSelect()">execSelect</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstruct()">
<h3>execConstruct</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">execConstruct</span>()</div>
<div class="block">Execute a CONSTRUCT query</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstruct()">execConstruct</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstruct(org.apache.jena.rdf.model.Model)">
<h3>execConstruct</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">execConstruct</span><wbr><span class="parameters">(org.apache.jena.rdf.model.Model&nbsp;model)</span></div>
<div class="block">Execute a CONSTRUCT query, putting the statements into a graph.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstruct(org.apache.jena.rdf.model.Model)">execConstruct</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>Graph The model argument for cascaded code.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstructTriples()">
<h3>execConstructTriples</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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;org.apache.jena.graph.Triple&gt;</span>&nbsp;<span class="element-name">execConstructTriples</span>()</div>
<div class="block">Execute a CONSTRUCT query, returning the results as an iterator of <code>Triple</code>.
<p>
<b>Caution:</b> This method may return duplicate Triples. This method may be useful if you only
need the results for stream processing, as it can avoid having to place the results in a Model.
</p>
<p>
<strong>Important:</strong> The name of this method is somewhat of a misnomer in that
depending on the underlying implementation this typically does not execute the
CONSTRUCT query but rather answers a wrapper over an internal data structure that can be
used to answer the query. In essence calling this method only returns a plan for
executing this query which only gets evaluated when you actually start iterating
over the results.
</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstructTriples()">execConstructTriples</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>An iterator of Triple objects (possibly containing duplicates) generated
by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstructQuads()">
<h3>execConstructQuads</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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="../core/Quad.html" title="class in org.apache.jena.sparql.core">Quad</a>&gt;</span>&nbsp;<span class="element-name">execConstructQuads</span>()</div>
<div class="block">Execute a CONSTRUCT query, returning the results as an iterator of <a href="../core/Quad.html" title="class in org.apache.jena.sparql.core"><code>Quad</code></a>.
<p>
<b>Caution:</b> This method may return duplicate Quads. This method may be useful if you only
need the results for stream processing, as it can avoid having to place the results in a Model.
<p>
An iterator of Quad objects (possibly containing duplicates) generated
by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.
<p>
See <a href="#execConstructTriples()"><code>execConstructTriples()</code></a> for usage and features.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstructQuads()">execConstructQuads</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>An iterator of Quad objects (possibly containing duplicates) generated
by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstructDataset()">
<h3>execConstructDataset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></span>&nbsp;<span class="element-name">execConstructDataset</span>()</div>
<div class="block">Execute a CONSTRUCT query, putting the statements into 'dataset'.
This maybe an extended syntax query (if supported).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstructDataset()">execConstructDataset</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execConstructDataset(org.apache.jena.query.Dataset)">
<h3>execConstructDataset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a></span>&nbsp;<span class="element-name">execConstructDataset</span><wbr><span class="parameters">(<a href="../../query/Dataset.html" title="interface in org.apache.jena.query">Dataset</a>&nbsp;dataset)</span></div>
<div class="block">Execute a CONSTRUCT query, putting the statements into 'dataset'.
This may be an extended syntax query (if supported).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execConstructDataset(org.apache.jena.query.Dataset)">execConstructDataset</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execDescribe()">
<h3>execDescribe</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">execDescribe</span>()</div>
<div class="block">Execute a DESCRIBE query</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execDescribe()">execDescribe</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execDescribe(org.apache.jena.rdf.model.Model)">
<h3>execDescribe</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">execDescribe</span><wbr><span class="parameters">(org.apache.jena.rdf.model.Model&nbsp;model)</span></div>
<div class="block">Execute a DESCRIBE query, putting the statements into a graph.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execDescribe(org.apache.jena.rdf.model.Model)">execDescribe</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>Graph The model argument for cascaded code.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execDescribeTriples()">
<h3>execDescribeTriples</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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;org.apache.jena.graph.Triple&gt;</span>&nbsp;<span class="element-name">execDescribeTriples</span>()</div>
<div class="block">Execute a DESCRIBE query, returning the results as an iterator of <code>Triple</code>.
<p>
<b>Caution:</b> This method may return duplicate Triples. This method may be useful if you only
need the results for stream processing, as it can avoid having to place the results in a Model.
</p>
<p>
<strong>Important:</strong> The name of this method is somewhat of a misnomer in that
depending on the underlying implementation this typically does not execute the
DESCRIBE query but rather answers a wrapper over an internal data structure that can be
used to answer the query. In essence calling this method only returns a plan for
executing this query which only gets evaluated when you actually start iterating
over the results.
</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execDescribeTriples()">execDescribeTriples</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>An iterator of Triple objects (possibly containing duplicates) generated as the output of the DESCRIBE query.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execAsk()">
<h3>execAsk</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">execAsk</span>()</div>
<div class="block">Execute an ASK query</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execAsk()">execAsk</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execJson()">
<h3>execJson</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../atlas/json/JsonArray.html" title="class in org.apache.jena.atlas.json">JsonArray</a></span>&nbsp;<span class="element-name">execJson</span>()</div>
<div class="block">Execute a JSON query and return a json array</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execJson()">execJson</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execJsonItems()">
<h3>execJsonItems</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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="../../atlas/json/JsonObject.html" title="class in org.apache.jena.atlas.json">JsonObject</a>&gt;</span>&nbsp;<span class="element-name">execJsonItems</span>()</div>
<div class="block">Execute a JSON query and return an iterator</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#execJsonItems()">execJsonItems</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="abort()">
<h3>abort</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">abort</span>()</div>
<div class="block">Stop in mid execution.
This method can be called in parallel with other methods on the
QueryExecution object.
There is no guarantee that the concrete implementation actual
will stop or that it will do so immediately.
No operations on the query execution or any associated
result set are permitted after this call and may cause exceptions to be thrown.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#abort()">abort</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
<div class="block">Close the query execution and stop query evaluation as soon as convenient.
QueryExecution objects, and a <a href="../../query/ResultSet.html" title="interface in org.apache.jena.query"><code>ResultSet</code></a> from <a href="#execSelect()"><code>execSelect()</code></a>,
can not be used once the QueryExecution is closed.
Model results from <a href="#execConstruct()"><code>execConstruct()</code></a> and <a href="#execDescribe()"><code>execDescribe()</code></a>
are still valid.
It is important to close query execution objects in order to release
resources such as working memory and to stop the query execution.
Some storage subsystems require explicit ends of operations and this
operation will cause those to be called where necessary.
No operations on the query execution or any associated
result set are permitted after this call.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isClosed()">
<h3>isClosed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isClosed</span>()</div>
<div class="block">Answer whether this QueryExecution object has been closed or not.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#isClosed()">isClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
<dt>Returns:</dt>
<dd>boolean</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTimeout1()">
<h3>getTimeout1</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getTimeout1</span>()</div>
<div class="block">Return the first timeout (time to first result), in milliseconds: negative if unset</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getTimeout1()">getTimeout1</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTimeout2()">
<h3>getTimeout2</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getTimeout2</span>()</div>
<div class="block">Return the second timeout (overall query execution after first result), in milliseconds: negative if unset</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../query/QueryExecution.html#getTimeout2()">getTimeout2</a></code>&nbsp;in interface&nbsp;<code><a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
</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>