| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>QueryExec (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, interface: QueryExec"> |
| <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/QueryExec.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.exec</a></div> |
| <h1 title="Interface QueryExec" class="title">Interface QueryExec</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="QueryExecAdapter.html" title="class in org.apache.jena.sparql.exec">QueryExecAdapter</a></code>, <code><a href="QueryExecApp.html" title="class in org.apache.jena.sparql.exec">QueryExecApp</a></code>, <code><a href="QueryExecDataset.html" title="class in org.apache.jena.sparql.exec">QueryExecDataset</a></code>, <code><a href="http/QueryExecHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecHTTP</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryExec</span><span class="extends-implements"> |
| extends <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></span></div> |
| <div class="block">Query execution interface 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-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="#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-tab3"> |
| <div class="block">Stop in mid execution.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="QueryExec.html" title="interface in org.apache.jena.sparql.exec">QueryExec</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#adapt(org.apache.jena.query.QueryExecution)" class="member-name-link">adapt</a><wbr>(<a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a> qExec)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <div class="block">Execute an ASK query</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Close the query execution and stop query evaluation as soon as convenient.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default org.apache.jena.graph.Graph</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"> |
| <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-tab3"><code>org.apache.jena.graph.Graph</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#construct(org.apache.jena.graph.Graph)" class="member-name-link">construct</a><wbr>(org.apache.jena.graph.Graph graph)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab5"><code>default <a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#constructDataset()" class="member-name-link">constructDataset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <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-tab3"><code><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#constructDataset(org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">constructDataset</a><wbr>(<a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> dataset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><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="../core/Quad.html" title="class in org.apache.jena.sparql.core">Quad</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#constructQuads()" class="member-name-link">constructQuads</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><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><org.apache.jena.graph.Triple></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#constructTriples()" class="member-name-link">constructTriples</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab1"><code>static <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#dataset(org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">dataset</a><wbr>(<a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> dataset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a dataset.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default org.apache.jena.graph.Graph</code></div> |
| <div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Execute a DESCRIBE query</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.jena.graph.Graph</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#describe(org.apache.jena.graph.Graph)" class="member-name-link">describe</a><wbr>(org.apache.jena.graph.Graph graph)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Execute a DESCRIBE query, putting the statements into a graph.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><org.apache.jena.graph.Triple></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#describeTriples()" class="member-name-link">describeTriples</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Execute a DESCRIBE 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-tab3"><code><a href="../../atlas/json/JsonArray.html" title="class in org.apache.jena.atlas.json">JsonArray</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execJson()" class="member-name-link">execJson</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Execute a JSON query and return a json array</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="../../atlas/json/JsonObject.html" title="class in org.apache.jena.atlas.json">JsonObject</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execJsonItems()" class="member-name-link">execJsonItems</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Execute a JSON query and return an iterator</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><code><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> |
| <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-tab3"><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-tab3"><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-tab3"> |
| <div class="block">The query as a string.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#graph(org.apache.jena.graph.Graph)" class="member-name-link">graph</a><wbr>(org.apache.jena.graph.Graph graph)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a graph.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Answer whether this QueryExecution object has been closed or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="QueryExecDatasetBuilder.html" title="class in org.apache.jena.sparql.exec">QueryExecDatasetBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Create an uninitialized <a href="QueryExecDatasetBuilder.html" title="class in org.apache.jena.sparql.exec"><code>QueryExecDatasetBuilder</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#select()" class="member-name-link">select</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Execute a SELECT query</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#service(java.lang.String)" class="member-name-link">service</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> serviceURL)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a remote endpoint.</div> |
| </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="dataset(org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>dataset</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></span> <span class="element-name">dataset</span><wbr><span class="parameters">(<a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> dataset)</span></div> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a dataset. |
| For local dataset specific configuration, use <a href="#newBuilder()"><code>newBuilder()</code></a>().dataset(dataset) |
| to get a <a href="QueryExecDatasetBuilder.html" title="class in org.apache.jena.sparql.exec"><code>QueryExecDatasetBuilder</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="graph(org.apache.jena.graph.Graph)"> |
| <h3>graph</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></span> <span class="element-name">graph</span><wbr><span class="parameters">(org.apache.jena.graph.Graph graph)</span></div> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a graph.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="service(java.lang.String)"> |
| <h3>service</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec">QueryExecBuilder</a></span> <span class="element-name">service</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> serviceURL)</span></div> |
| <div class="block">Create a <a href="QueryExecBuilder.html" title="interface in org.apache.jena.sparql.exec"><code>QueryExecBuilder</code></a> for a remote endpoint.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newBuilder()"> |
| <h3>newBuilder</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryExecDatasetBuilder.html" title="class in org.apache.jena.sparql.exec">QueryExecDatasetBuilder</a></span> <span class="element-name">newBuilder</span>()</div> |
| <div class="block">Create an uninitialized <a href="QueryExecDatasetBuilder.html" title="class in org.apache.jena.sparql.exec"><code>QueryExecDatasetBuilder</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataset()"> |
| <h3>getDataset</h3> |
| <div class="member-signature"><span class="return-type"><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></span> <span class="element-name">getDataset</span>()</div> |
| <div class="block">The dataset against which the query will execute. May be null - the dataset |
| may be remote or the query itself has a dataset description.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="../util/Context.html" title="class in org.apache.jena.sparql.util">Context</a></span> <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQuery()"> |
| <h3>getQuery</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../query/Query.html" title="class in org.apache.jena.query">Query</a></span> <span class="element-name">getQuery</span>()</div> |
| <div class="block">The query associated with a query execution. May be null (QueryExec may |
| have been created by other means)</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueryString()"> |
| <h3>getQueryString</h3> |
| <div class="member-signature"><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> <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="select()"> |
| <h3>select</h3> |
| <div class="member-signature"><span class="return-type"><a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a></span> <span class="element-name">select</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="construct()"> |
| <h3>construct</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">org.apache.jena.graph.Graph</span> <span class="element-name">construct</span>()</div> |
| <div class="block">Execute a CONSTRUCT query</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="construct(org.apache.jena.graph.Graph)"> |
| <h3>construct</h3> |
| <div class="member-signature"><span class="return-type">org.apache.jena.graph.Graph</span> <span class="element-name">construct</span><wbr><span class="parameters">(org.apache.jena.graph.Graph graph)</span></div> |
| <div class="block">Execute a CONSTRUCT query, putting the statements into a graph.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Graph The graph argument for cascaded code.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="constructTriples()"> |
| <h3>constructTriples</h3> |
| <div class="member-signature"><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><org.apache.jena.graph.Triple></span> <span class="element-name">constructTriples</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>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="constructQuads()"> |
| <h3>constructQuads</h3> |
| <div class="member-signature"><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><<a href="../core/Quad.html" title="class in org.apache.jena.sparql.core">Quad</a>></span> <span class="element-name">constructQuads</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> |
| See <a href="#constructTriples()"><code>constructTriples()</code></a> for usage and features. |
| </p></div> |
| <dl class="notes"> |
| <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="constructDataset()"> |
| <h3>constructDataset</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></span> <span class="element-name">constructDataset</span>()</div> |
| <div class="block">Execute a CONSTRUCT query, putting the statements into 'dataset'. This maybe |
| an extended syntax query (if supported).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="constructDataset(org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>constructDataset</h3> |
| <div class="member-signature"><span class="return-type"><a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a></span> <span class="element-name">constructDataset</span><wbr><span class="parameters">(<a href="../core/DatasetGraph.html" title="interface in org.apache.jena.sparql.core">DatasetGraph</a> 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="describe()"> |
| <h3>describe</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">org.apache.jena.graph.Graph</span> <span class="element-name">describe</span>()</div> |
| <div class="block">Execute a DESCRIBE query</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="describe(org.apache.jena.graph.Graph)"> |
| <h3>describe</h3> |
| <div class="member-signature"><span class="return-type">org.apache.jena.graph.Graph</span> <span class="element-name">describe</span><wbr><span class="parameters">(org.apache.jena.graph.Graph graph)</span></div> |
| <div class="block">Execute a DESCRIBE query, putting the statements into a graph.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Graph The model argument for cascaded code.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="describeTriples()"> |
| <h3>describeTriples</h3> |
| <div class="member-signature"><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><org.apache.jena.graph.Triple></span> <span class="element-name">describeTriples</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>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="ask()"> |
| <h3>ask</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">ask</span>()</div> |
| <div class="block">Execute an ASK query</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execJson()"> |
| <h3>execJson</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../atlas/json/JsonArray.html" title="class in org.apache.jena.atlas.json">JsonArray</a></span> <span class="element-name">execJson</span>()</div> |
| <div class="block">Execute a JSON query and return a json array</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execJsonItems()"> |
| <h3>execJsonItems</h3> |
| <div class="member-signature"><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><<a href="../../atlas/json/JsonObject.html" title="class in org.apache.jena.atlas.json">JsonObject</a>></span> <span class="element-name">execJsonItems</span>()</div> |
| <div class="block">Execute a JSON query and return an iterator</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abort()"> |
| <h3>abort</h3> |
| <div class="member-signature"><span class="return-type">void</span> <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block">Close the query execution and stop query evaluation as soon as convenient. |
| QExec objects, and a <a href="RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a> from <a href="#select()"><code>select()</code></a>, can not be used once |
| the QExec is closed. Model results from <a href="#construct()"><code>construct()</code></a> and |
| <a href="#describe()"><code>describe()</code></a> are still valid. |
| <p> |
| 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> in interface <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> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isClosed()"> |
| <h3>isClosed</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <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>Returns:</dt> |
| <dd>boolean</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="adapt(org.apache.jena.query.QueryExecution)"> |
| <h3>adapt</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryExec.html" title="interface in org.apache.jena.sparql.exec">QueryExec</a></span> <span class="element-name">adapt</span><wbr><span class="parameters">(<a href="../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a> qExec)</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> |
