blob: 9e28fcbb6eb8657c780bd1beddabd24ed6ff56e1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>QueryExecutionBuilder (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.query, interface: QueryExecutionBuilder">
<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/QueryExecutionBuilder.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.query</a></div>
<h1 title="Interface QueryExecutionBuilder" class="title">Interface QueryExecutionBuilder</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../sparql/exec/QueryExecutionBuilderAdapter.html" title="class in org.apache.jena.sparql.exec">QueryExecutionBuilderAdapter</a></code>, <code><a href="QueryExecutionDatasetBuilder.html" title="class in org.apache.jena.query">QueryExecutionDatasetBuilder</a></code>, <code><a href="../sparql/exec/http/QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryExecutionBuilder</span></div>
<div class="block">Common elements of query execution building.
<p>
The dataset (<a href="QueryExecutionDatasetBuilder.html" title="class in org.apache.jena.query"><code>QueryExecutionDatasetBuilder</code></a>) and remote endpoint (<a href="../sparql/exec/http/QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http"><code>QueryExecutionHTTPBuilder</code></a>)
set the target for the <a href="QueryExecution.html" title="interface in org.apache.jena.query"><code>QueryExecution</code></a> and may provide operations specific to those two cases.
<p>
Appropriate builders are available from {QueryExecution#dataset(Dataset)} and <a href="QueryExecution.html#service(java.lang.String)"><code>QueryExecution.service(String)</code></a>.</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-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#ask()" class="member-name-link">ask</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="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-tab2 method-summary-table-tab3"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default 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-tab5"><code><a href="#construct()" class="member-name-link">construct</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#context(org.apache.jena.sparql.util.Context)" class="member-name-link">context</a><wbr>(<a href="../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default 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-tab5"><code><a href="#describe()" class="member-name-link">describe</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#query(java.lang.String)" class="member-name-link">query</a><wbr>(<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>&nbsp;queryString)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#query(java.lang.String,org.apache.jena.query.Syntax)" class="member-name-link">query</a><wbr>(<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>&nbsp;queryString,
<a href="Syntax.html" title="class in org.apache.jena.query">Syntax</a>&nbsp;syntax)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#query(org.apache.jena.query.Query)" class="member-name-link">query</a><wbr>(<a href="Query.html" title="class in org.apache.jena.query">Query</a>&nbsp;query)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ResultSet.html" title="interface in org.apache.jena.query">ResultSet</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#select()" class="member-name-link">select</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#set(org.apache.jena.sparql.util.Symbol,boolean)" class="member-name-link">set</a><wbr>(<a href="../sparql/util/Symbol.html" title="class in org.apache.jena.sparql.util">Symbol</a>&nbsp;symbol,
boolean&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#set(org.apache.jena.sparql.util.Symbol,java.lang.Object)" class="member-name-link">set</a><wbr>(<a href="../sparql/util/Symbol.html" title="class in org.apache.jena.sparql.util">Symbol</a>&nbsp;symbol,
<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>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#substitution(java.lang.String,org.apache.jena.rdf.model.RDFNode)" class="member-name-link">substitution</a><wbr>(<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>&nbsp;varName,
org.apache.jena.rdf.model.RDFNode&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#substitution(org.apache.jena.query.QuerySolution)" class="member-name-link">substitution</a><wbr>(<a href="QuerySolution.html" title="interface in org.apache.jena.query">QuerySolution</a>&nbsp;querySolution)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#timeout(long)" class="member-name-link">timeout</a><wbr>(long&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#timeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">timeout</a><wbr>(long&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;timeUnit)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</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="query(org.apache.jena.query.Query)">
<h3>query</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<a href="Query.html" title="class in org.apache.jena.query">Query</a>&nbsp;query)</span></div>
</section>
</li>
<li>
<section class="detail" id="query(java.lang.String)">
<h3>query</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<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>&nbsp;queryString)</span></div>
</section>
</li>
<li>
<section class="detail" id="query(java.lang.String,org.apache.jena.query.Syntax)">
<h3>query</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<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>&nbsp;queryString,
<a href="Syntax.html" title="class in org.apache.jena.query">Syntax</a>&nbsp;syntax)</span></div>
</section>
</li>
<li>
<section class="detail" id="set(org.apache.jena.sparql.util.Symbol,java.lang.Object)">
<h3>set</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">set</span><wbr><span class="parameters">(<a href="../sparql/util/Symbol.html" title="class in org.apache.jena.sparql.util">Symbol</a>&nbsp;symbol,
<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>&nbsp;value)</span></div>
</section>
</li>
<li>
<section class="detail" id="set(org.apache.jena.sparql.util.Symbol,boolean)">
<h3>set</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">set</span><wbr><span class="parameters">(<a href="../sparql/util/Symbol.html" title="class in org.apache.jena.sparql.util">Symbol</a>&nbsp;symbol,
boolean&nbsp;value)</span></div>
</section>
</li>
<li>
<section class="detail" id="context(org.apache.jena.sparql.util.Context)">
<h3>context</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">context</span><wbr><span class="parameters">(<a href="../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</span></div>
</section>
</li>
<li>
<section class="detail" id="substitution(org.apache.jena.query.QuerySolution)">
<h3>substitution</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">substitution</span><wbr><span class="parameters">(<a href="QuerySolution.html" title="interface in org.apache.jena.query">QuerySolution</a>&nbsp;querySolution)</span></div>
</section>
</li>
<li>
<section class="detail" id="substitution(java.lang.String,org.apache.jena.rdf.model.RDFNode)">
<h3>substitution</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">substitution</span><wbr><span class="parameters">(<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>&nbsp;varName,
org.apache.jena.rdf.model.RDFNode&nbsp;value)</span></div>
</section>
</li>
<li>
<section class="detail" id="timeout(long,java.util.concurrent.TimeUnit)">
<h3>timeout</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">timeout</span><wbr><span class="parameters">(long&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;timeUnit)</span></div>
</section>
</li>
<li>
<section class="detail" id="timeout(long)">
<h3>timeout</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="QueryExecutionBuilder.html" title="interface in org.apache.jena.query">QueryExecutionBuilder</a></span>&nbsp;<span class="element-name">timeout</span><wbr><span class="parameters">(long&nbsp;value)</span></div>
</section>
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="return-type"><a href="QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></span>&nbsp;<span class="element-name">build</span>()</div>
</section>
</li>
<li>
<section class="detail" id="select()">
<h3>select</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="ResultSet.html" title="interface in org.apache.jena.query">ResultSet</a></span>&nbsp;<span class="element-name">select</span>()</div>
</section>
</li>
<li>
<section class="detail" id="construct()">
<h3>construct</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">construct</span>()</div>
</section>
</li>
<li>
<section class="detail" id="describe()">
<h3>describe</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">org.apache.jena.rdf.model.Model</span>&nbsp;<span class="element-name">describe</span>()</div>
</section>
</li>
<li>
<section class="detail" id="ask()">
<h3>ask</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">ask</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>