Google Git
Sign in
apache / jena-site / refs/heads/javadoc / . / arq / org.apache.jena.arq / org / apache / jena / sparql / exec / RowSetOps.html
blob: 2a1cadcbdd786a99e3ea261e18305d6a368a24f0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RowSetOps (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: RowSetOps">
<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/RowSetOps.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 RowSetOps" class="title">Class RowSetOps</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.RowSetOps</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RowSetOps</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></span></div>
<div class="block">RowSetFormatter - Convenience ways to call the various output formatters.
in various formats.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../riot/ResultSetMgr.html" title="class in org.apache.jena.riot"><code>ResultSetMgr</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-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-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#consume(org.apache.jena.sparql.exec.RowSet)" class="member-name-link">consume</a><wbr>(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">This operation faithfully walks the rowSet but does nothing with the rows.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#count(org.apache.jena.sparql.exec.RowSet)" class="member-name-link">count</a><wbr>(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Count the rows in the RowSet (from the current point of RowSet).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(boolean)" class="member-name-link">out</a><wbr>(boolean&nbsp;answer)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output an ASK answer</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(java.io.OutputStream,boolean)" class="member-name-link">out</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
boolean&nbsp;answer)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output an ASK answer</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet)" class="member-name-link">out</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output a result set in a text format.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet,org.apache.jena.riot.system.PrefixMap)" class="member-name-link">out</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;resultSet,
<a href="../../riot/system/PrefixMap.html" title="interface in org.apache.jena.riot.system">PrefixMap</a>&nbsp;pmap)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output a result set in a text format.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet,org.apache.jena.sparql.core.Prologue)" class="member-name-link">out</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet,
<a href="../core/Prologue.html" title="class in org.apache.jena.sparql.core">Prologue</a>&nbsp;prologue)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output a result set in a text format.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#out(org.apache.jena.sparql.exec.RowSet)" class="member-name-link">out</a><wbr>(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Output a result set in a text format.</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="consume(org.apache.jena.sparql.exec.RowSet)">
<h3>consume</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">consume</span><wbr><span class="parameters">(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</span></div>
<div class="block">This operation faithfully walks the rowSet but does nothing with the rows.</div>
</section>
</li>
<li>
<section class="detail" id="count(org.apache.jena.sparql.exec.RowSet)">
<h3>count</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">count</span><wbr><span class="parameters">(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</span></div>
<div class="block">Count the rows in the RowSet (from the current point of RowSet).
This operation consumes the RowSet.</div>
</section>
</li>
<li>
<section class="detail" id="out(org.apache.jena.sparql.exec.RowSet)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</span></div>
<div class="block">Output a result set in a text format. The result set is consumed.
Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.
<p>
This caches the entire results in memory in order to determine the appropriate
column widths and therefore may exhaust memory for large results
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rowSet</code> - result set</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet)</span></div>
<div class="block">Output a result set in a text format.
<p>
This caches the entire results in memory in order to determine the appropriate
column widths and therefore may exhaust memory for large results
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>out</code> - OutputStream</dd>
<dd><code>rowSet</code> - result set</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet,org.apache.jena.riot.system.PrefixMap)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;resultSet,
<a href="../../riot/system/PrefixMap.html" title="interface in org.apache.jena.riot.system">PrefixMap</a>&nbsp;pmap)</span></div>
<div class="block">Output a result set in a text format.
<p>
This caches the entire results in memory in order to determine the appropriate
column widths and therefore may exhaust memory for large results
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>out</code> - OutputStream</dd>
<dd><code>resultSet</code> - Result set</dd>
<dd><code>pmap</code> - Prefix mapping for abbreviating URIs.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="out(java.io.OutputStream,org.apache.jena.sparql.exec.RowSet,org.apache.jena.sparql.core.Prologue)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
<a href="RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a>&nbsp;rowSet,
<a href="../core/Prologue.html" title="class in org.apache.jena.sparql.core">Prologue</a>&nbsp;prologue)</span></div>
<div class="block">Output a result set in a text format. The result set is consumed.
Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.
<p>
This caches the entire results in memory in order to determine the appropriate
column widths and therefore may exhaust memory for large results
</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>out</code> - OutputStream</dd>
<dd><code>rowSet</code> - result set</dd>
<dd><code>prologue</code> - Prologue, used to abbreviate IRIs</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="out(boolean)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(boolean&nbsp;answer)</span></div>
<div class="block">Output an ASK answer</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>answer</code> - The boolean answer</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="out(java.io.OutputStream,boolean)">
<h3>out</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">out</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;out,
boolean&nbsp;answer)</span></div>
<div class="block">Output an ASK answer</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>out</code> - OutputStream</dd>
<dd><code>answer</code> - The boolean answer</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>