blob: b6ca99345d8bf78fa79cee7563c00d055812a37c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RowSetReader (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.riot.rowset, interface: RowSetReader">
<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/RowSetReader.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.riot.rowset</a></div>
<h1 title="Interface RowSetReader" class="title">Interface RowSetReader</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="rw/RowSetReaderCSV.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderCSV</a></code>, <code><a href="rw/RowSetReaderJSON_V1.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderJSON_V1</a></code>, <code><a href="rw/RowSetReaderJSONStreaming.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderJSONStreaming</a></code>, <code><a href="rw/RowSetReaderNone.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderNone</a></code>, <code><a href="rw/RowSetReaderProtobuf.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderProtobuf</a></code>, <code><a href="rw/RowSetReaderThrift.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderThrift</a></code>, <code><a href="rw/RowSetReaderTSV.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderTSV</a></code>, <code><a href="rw/RowSetReaderXML.html" title="class in org.apache.jena.riot.rowset.rw">RowSetReaderXML</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RowSetReader</span></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 <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#read(java.io.InputStream,org.apache.jena.sparql.util.Context)" class="member-name-link">read</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in,
<a href="../../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Read from an <code>InputStream</code> and produce a <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../../sparql/exec/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-tab5"><code><a href="#read(java.io.Reader,org.apache.jena.sparql.util.Context)" class="member-name-link">read</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a>&nbsp;in,
<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-tab5">
<div class="block"><em>Using <a href="#read(java.io.InputStream,org.apache.jena.sparql.util.Context)"><code>read(InputStream, Context)</code></a> is preferred.</em></div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../sparql/exec/QueryExecResult.html" title="class in org.apache.jena.sparql.exec">QueryExecResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readAny(java.io.InputStream,org.apache.jena.sparql.util.Context)" class="member-name-link">readAny</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in,
<a href="../../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Read from an <code>InputStream</code> and produce a <a href="../../sparql/exec/QueryExecResult.html" title="class in org.apache.jena.sparql.exec"><code>QueryExecResult</code></a>.</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="read(java.io.InputStream,org.apache.jena.sparql.util.Context)">
<h3>read</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a></span>&nbsp;<span class="element-name">read</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in,
<a href="../../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</span></div>
<div class="block">Read from an <code>InputStream</code> and produce a <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a>.
Note that return row set may stream and so the input stream may be read
while the <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a> is used.
See <a href="../../sparql/exec/RowSet.html#materialize()"><code>RowSet.materialize()</code></a> for a RowSet that is detached from the <code>InputStream</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>in</code> - InputStream to read from.</dd>
<dd><code>context</code> - </dd>
<dt>Returns:</dt>
<dd>RowSet</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="readAny(java.io.InputStream,org.apache.jena.sparql.util.Context)">
<h3>readAny</h3>
<div class="member-signature"><span class="return-type"><a href="../../sparql/exec/QueryExecResult.html" title="class in org.apache.jena.sparql.exec">QueryExecResult</a></span>&nbsp;<span class="element-name">readAny</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in,
<a href="../../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</span></div>
<div class="block">Read from an <code>InputStream</code> and produce a <a href="../../sparql/exec/QueryExecResult.html" title="class in org.apache.jena.sparql.exec"><code>QueryExecResult</code></a>.
Note that return result may stream and so the input stream may be read
while the <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a> is used.
See <a href="#read(java.io.InputStream,org.apache.jena.sparql.util.Context)"><code>read(InputStream, Context)</code></a> for more details</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>in</code> - InputStream to read from.</dd>
<dd><code>context</code> - </dd>
<dt>Returns:</dt>
<dd>QueryExecResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="read(java.io.Reader,org.apache.jena.sparql.util.Context)">
<h3>read</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec">RowSet</a></span>&nbsp;<span class="element-name">read</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a>&nbsp;in,
<a href="../../sparql/util/Context.html" title="class in org.apache.jena.sparql.util">Context</a>&nbsp;context)</span></div>
<div class="block"><em>Using <a href="#read(java.io.InputStream,org.apache.jena.sparql.util.Context)"><code>read(InputStream, Context)</code></a> is preferred.</em>
<p>
Not all formats support reading from a <code>java.io.Reader</code>.
<p>
Read from an <code>Reader</code> and produce a <a href="../../sparql/exec/RowSet.html" title="interface in org.apache.jena.sparql.exec"><code>RowSet</code></a>.
Note that return result may stream and so the reader may be read
while the RowSet is used.
See <a href="../../sparql/exec/RowSet.html#materialize()"><code>RowSet.materialize()</code></a> for a RowSet that is detached from the <code>InputStream</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>in</code> - Reader</dd>
<dd><code>context</code> - </dd>
<dt>Returns:</dt>
<dd>RowSet</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>