Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / store / pojo / AbstractPojoRecordReader.html
blob: 7360f52a961f75cfbee9ce905c6c409a220c59fd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractPojoRecordReader (Drill : 1.20.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractPojoRecordReader (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractPojoRecordReader.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoWriter.html" title="class in org.apache.drill.exec.store.pojo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" target="_top">Frames</a></li>
<li><a href="AbstractPojoRecordReader.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.drill.exec.store.pojo</div>
<h2 title="Class AbstractPojoRecordReader" class="title">Class AbstractPojoRecordReader&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html" title="class in org.apache.drill.exec.store">org.apache.drill.exec.store.AbstractRecordReader</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.store.pojo.AbstractPojoRecordReader&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;, <a href="../../../../../../org/apache/drill/exec/store/RecordReader.html" title="interface in org.apache.drill.exec.store">RecordReader</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/store/pojo/DynamicPojoRecordReader.html" title="class in org.apache.drill.exec.store.pojo">DynamicPojoRecordReader</a>, <a href="../../../../../../org/apache/drill/exec/store/pojo/PojoRecordReader.html" title="class in org.apache.drill.exec.store.pojo">PojoRecordReader</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPojoRecordReader&lt;T&gt;</span>
extends <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html" title="class in org.apache.drill.exec.store">AbstractRecordReader</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;</pre>
<div class="block">Parent class for all pojo readers. Pojo readers can be based on java class (field list is predefined) or dynamic.
Contains general logic for initiating writers and reading values from each row fields.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#DEFAULT_RECORDS_PER_BATCH">DEFAULT_RECORDS_PER_BATCH</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#records">records</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#writers">writers</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.store.AbstractRecordReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.drill.exec.store.<a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html" title="class in org.apache.drill.exec.store">AbstractRecordReader</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#DEFAULT_TEXT_COLS_TO_READ">DEFAULT_TEXT_COLS_TO_READ</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.store.RecordReader">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.drill.exec.store.<a href="../../../../../../org/apache/drill/exec/store/RecordReader.html" title="interface in org.apache.drill.exec.store">RecordReader</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#ALLOCATOR_INITIAL_RESERVATION">ALLOCATOR_INITIAL_RESERVATION</a>, <a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#ALLOCATOR_MAX_RESERVATION">ALLOCATOR_MAX_RESERVATION</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#AbstractPojoRecordReader-java.util.List-">AbstractPojoRecordReader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;&nbsp;records)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#AbstractPojoRecordReader-java.util.List-int-">AbstractPojoRecordReader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;&nbsp;records,
int&nbsp;recordsPerBatch)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#allocate-java.util.Map-">allocate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&gt;&nbsp;vectorMap)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#getFieldValue-T-int-">getFieldValue</a></span>(<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&nbsp;row,
int&nbsp;fieldPosition)</code>
<div class="block">Retrieves field value to be written based for given row and field position.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#initWriter-java.lang.Class-java.lang.String-org.apache.drill.exec.physical.impl.OutputMutator-">initWriter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fieldName,
<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)</code>
<div class="block">Creates writer based input class type and then initiates it.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#iterator--">iterator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#next--">next</a></span>()</code>
<div class="block">Increments this record reader forward, writing via the provided output
mutator into the output batch.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#setup-org.apache.drill.exec.ops.OperatorContext-org.apache.drill.exec.physical.impl.OutputMutator-">setup</a></span>(<a href="../../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a>&nbsp;context,
<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)</code>
<div class="block">Configure the RecordReader with the provided schema and the record batch that should be written to.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html#setupWriters-org.apache.drill.exec.physical.impl.OutputMutator-">setupWriters</a></span>(<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)</code>
<div class="block">Setups writers for each field in the row.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.store.AbstractRecordReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.store.<a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html" title="class in org.apache.drill.exec.store">AbstractRecordReader</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#getColumns--">getColumns</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#getDefaultColumnsToRead--">getDefaultColumnsToRead</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#hasNext--">hasNext</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#isSkipQuery--">isSkipQuery</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#isStarQuery--">isStarQuery</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#setColumns-java.util.Collection-">setColumns</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#toString--">toString</a>, <a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#transformColumns-java.util.Collection-">transformColumns</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_RECORDS_PER_BATCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_RECORDS_PER_BATCH</h4>
<pre>public static final&nbsp;int DEFAULT_RECORDS_PER_BATCH</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.drill.exec.store.pojo.AbstractPojoRecordReader.DEFAULT_RECORDS_PER_BATCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="records">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>records</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt; records</pre>
</li>
</ul>
<a name="writers">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writers</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a>&gt; writers</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractPojoRecordReader-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractPojoRecordReader</h4>
<pre>protected&nbsp;AbstractPojoRecordReader(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;&nbsp;records)</pre>
</li>
</ul>
<a name="AbstractPojoRecordReader-java.util.List-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPojoRecordReader</h4>
<pre>protected&nbsp;AbstractPojoRecordReader(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;&nbsp;records,
int&nbsp;recordsPerBatch)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setup-org.apache.drill.exec.ops.OperatorContext-org.apache.drill.exec.physical.impl.OutputMutator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>public&nbsp;void&nbsp;setup(<a href="../../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a>&nbsp;context,
<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)
throws <a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#setup-org.apache.drill.exec.ops.OperatorContext-org.apache.drill.exec.physical.impl.OutputMutator-">RecordReader</a></code></span></div>
<div class="block">Configure the RecordReader with the provided schema and the record batch that should be written to.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#setup-org.apache.drill.exec.ops.OperatorContext-org.apache.drill.exec.physical.impl.OutputMutator-">setup</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html" title="interface in org.apache.drill.exec.store">RecordReader</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - operator context for the reader</dd>
<dd><code>output</code> - The place where output for a particular scan should be written. The record reader is responsible for
mutating the set of schema values for that particular record.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></code></dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public&nbsp;int&nbsp;next()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#next--">RecordReader</a></code></span></div>
<div class="block">Increments this record reader forward, writing via the provided output
mutator into the output batch.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#next--">next</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html" title="interface in org.apache.drill.exec.store">RecordReader</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of additional records added to the output.</dd>
</dl>
</li>
</ul>
<a name="allocate-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre>public&nbsp;void&nbsp;allocate(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&gt;&nbsp;vectorMap)
throws <a href="../../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html#allocate-java.util.Map-">allocate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/RecordReader.html" title="interface in org.apache.drill.exec.store">RecordReader</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html#allocate-java.util.Map-">allocate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/exec/store/AbstractRecordReader.html" title="class in org.apache.drill.exec.store">AbstractRecordReader</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;&nbsp;iterator()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="initWriter-java.lang.Class-java.lang.String-org.apache.drill.exec.physical.impl.OutputMutator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initWriter</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a>&nbsp;initWriter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fieldName,
<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)
throws <a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></pre>
<div class="block">Creates writer based input class type and then initiates it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - class type</dd>
<dd><code>fieldName</code> - field name</dd>
<dd><code>output</code> - output mutator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>pojo writer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></code></dd>
</dl>
</li>
</ul>
<a name="setupWriters-org.apache.drill.exec.physical.impl.OutputMutator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupWriters</h4>
<pre>protected abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/exec/store/pojo/PojoWriter.html" title="interface in org.apache.drill.exec.store.pojo">PojoWriter</a>&gt;&nbsp;setupWriters(<a href="../../../../../../org/apache/drill/exec/physical/impl/OutputMutator.html" title="interface in org.apache.drill.exec.physical.impl">OutputMutator</a>&nbsp;output)
throws <a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></pre>
<div class="block">Setups writers for each field in the row.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - output mutator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of pojo writers</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></code></dd>
</dl>
</li>
</ul>
<a name="getFieldValue-java.lang.Object-int-">
<!-- -->
</a><a name="getFieldValue-T-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFieldValue</h4>
<pre>protected abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getFieldValue(<a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" title="type parameter in AbstractPojoRecordReader">T</a>&nbsp;row,
int&nbsp;fieldPosition)</pre>
<div class="block">Retrieves field value to be written based for given row and field position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>row</code> - current row</dd>
<dd><code>fieldPosition</code> - current field position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>field value to be written for given row</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractPojoRecordReader.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/drill/exec/store/pojo/AbstractPojoWriter.html" title="class in org.apache.drill.exec.store.pojo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/pojo/AbstractPojoRecordReader.html" target="_top">Frames</a></li>
<li><a href="AbstractPojoRecordReader.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>