blob: 78744d54e6683223bdbefc85fe3ac4d01945adbb [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>DictWriter (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="DictWriter (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DictWriter.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><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictReader.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/vector/accessor/Float4Accessor.html" title="class in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/DictWriter.html" target="_top">Frames</a></li>
<li><a href="DictWriter.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.vector.accessor</div>
<h2 title="Interface DictWriter" class="title">Interface DictWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/dummy/DummyDictWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer.dummy">DummyDictWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/ObjectDictWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">ObjectDictWriter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DictWriter</span>
extends <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></pre>
<div class="block">Physically the writer is an array writer with special tuple writer as its element.
Its <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#type--"><code>ColumnWriter.type()</code></a> returns <code>ARRAY</code> and <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entryType--"><code>ArrayWriter.entryType()</code></a> returns <code>TUPLE</code>.
To know whether it is a Dict logically, one may use <code>schema().isDict()</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/DictEntryWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer"><code>DictEntryWriter</code></a>,
<a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/ObjectDictWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer"><code>ObjectDictWriter</code></a>,
<a href="../../../../../../org/apache/drill/exec/vector/complex/DictVector.html" title="class in org.apache.drill.exec.vector.complex"><code>DictVector</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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></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><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html#keyType--">keyType</a></span>()</code>
<div class="block">Returns scalar type of the key field.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html#keyWriter--">keyWriter</a></span>()</code>
<div class="block">Returns the writer associated with key field.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html#valueType--">valueType</a></span>()</code>
<div class="block">Returns object type of the value field.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html#valueWriter--">valueWriter</a></span>()</code>
<div class="block">Returns the writer associated with value field.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ArrayWriter">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.vector.accessor.<a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#array--">array</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#dict--">dict</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entry--">entry</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entryType--">entryType</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#save--">save</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#scalar--">scalar</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#setNull-boolean-">setNull</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#size--">size</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#tuple--">tuple</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#variant--">variant</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ColumnWriter">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.vector.accessor.<a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#copy-org.apache.drill.exec.vector.accessor.ColumnReader-">copy</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#isProjected--">isProjected</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#nullable--">nullable</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#schema--">schema</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--">setNull</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setObject-java.lang.Object-">setObject</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#type--">type</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="keyType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyType</h4>
<pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a>&nbsp;keyType()</pre>
<div class="block">Returns scalar type of the key field.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of the key</dd>
</dl>
</li>
</ul>
<a name="valueType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueType</h4>
<pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a>&nbsp;valueType()</pre>
<div class="block">Returns object type of the value field.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of the value</dd>
</dl>
</li>
</ul>
<a name="keyWriter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyWriter</h4>
<pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarWriter</a>&nbsp;keyWriter()</pre>
<div class="block">Returns the writer associated with key field.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>key writer</dd>
</dl>
</li>
</ul>
<a name="valueWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueWriter</h4>
<pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a>&nbsp;valueWriter()</pre>
<div class="block">Returns the writer associated with value field.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value writer</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/DictWriter.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><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictReader.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/vector/accessor/Float4Accessor.html" title="class in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/DictWriter.html" target="_top">Frames</a></li>
<li><a href="DictWriter.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>