http://git-wip-us.apache.org/repos/asf/orc/blob/c06fe4d1/site/api/orc-core/org/apache/orc/impl/writer/StringBaseTreeWriter.html ---------------------------------------------------------------------- diff --git a/site/api/orc-core/org/apache/orc/impl/writer/StringBaseTreeWriter.html b/site/api/orc-core/org/apache/orc/impl/writer/StringBaseTreeWriter.html new file mode 100644 index 0000000..8dbf463 --- /dev/null +++ b/site/api/orc-core/org/apache/orc/impl/writer/StringBaseTreeWriter.html @@ -0,0 +1,498 @@ +<!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 (1.8.0_121) on Mon May 14 13:41:16 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StringBaseTreeWriter (ORC Core 1.5.0 API)</title> +<meta name="date" content="2018-05-14"> +<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="StringBaseTreeWriter (ORC Core 1.5.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/StringBaseTreeWriter.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/orc/impl/writer/MapTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/StringTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StringBaseTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StringBaseTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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.orc.impl.writer</div> +<h2 title="Class StringBaseTreeWriter" class="title">Class StringBaseTreeWriter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">org.apache.orc.impl.writer.TreeWriterBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.orc.impl.writer.StringBaseTreeWriter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/orc/impl/writer/CharTreeWriter.html" title="class in org.apache.orc.impl.writer">CharTreeWriter</a>, <a href="../../../../../org/apache/orc/impl/writer/StringTreeWriter.html" title="class in org.apache.orc.impl.writer">StringTreeWriter</a>, <a href="../../../../../org/apache/orc/impl/writer/VarcharTreeWriter.html" title="class in org.apache.orc.impl.writer">VarcharTreeWriter</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">StringBaseTreeWriter</span> +extends <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.orc.impl.writer.TreeWriter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.Factory.html" title="class in org.apache.orc.impl.writer">TreeWriter.Factory</a></code></li> +</ul> +</li> +</ul> +<!-- =========== 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"> </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>protected <a href="../../../../../org/apache/orc/impl/StringRedBlackTree.html" title="class in org.apache.orc.impl">StringRedBlackTree</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#dictionary">dictionary</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/orc/impl/PositionedOutputStream.html" title="class in org.apache.orc.impl">PositionedOutputStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#directStreamOutput">directStreamOutput</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/orc/impl/IntegerWriter.html" title="interface in org.apache.orc.impl">IntegerWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#lengthOutput">lengthOutput</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/orc/impl/DynamicIntArray.html" title="class in org.apache.orc.impl">DynamicIntArray</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#rows">rows</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#useDictionaryEncoding">useDictionaryEncoding</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilter">bloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterEntry">bloomFilterEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterUtf8">bloomFilterUtf8</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createBloomFilter">createBloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#fileStatistics">fileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#id">id</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#indexStatistics">indexStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#isPresent">isPresent</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#rowIndexPosition">rowIndexPosition</a>, <a href="../../../../../org/apache/orc/impl/writer /TreeWriterBase.html#stripeColStatistics">stripeColStatistics</a></code></li> +</ul> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/orc/impl/writer/StringBaseTreeWriter.html#createRowIndexEntry--">createRowIndexEntry</a></span>()</code> +<div class="block">This method doesn't call the super method, because unlike most of the + other TreeWriters, this one can't record the position in the streams + until the stripe is being flushed.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#estimateMemory--">estimateMemory</a></span>()</code> +<div class="block">Estimate how much memory the writer is consuming excluding the streams.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#flushStreams--">flushStreams</a></span>()</code> +<div class="block">Flush the TreeWriter stream</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#getRawDataSize--">getRawDataSize</a></span>()</code> +<div class="block">Estimate the memory used if the file was read into Hive's Writable + types.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter.Builder</a> builder, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics.Builder</a> stats, + int requiredIndexEntries)</code> +<div class="block">Write the stripe out to the file.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndex--">getRowIndex</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndexEntry--">getRowIndexEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getStripeStatistics--">getStripeStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">updateFileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">writeFileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">writeRootBatch</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</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="lengthOutput"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lengthOutput</h4> +<pre>protected final <a href="../../../../../org/apache/orc/impl/IntegerWriter.html" title="interface in org.apache.orc.impl">IntegerWriter</a> lengthOutput</pre> +</li> +</ul> +<a name="dictionary"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dictionary</h4> +<pre>protected final <a href="../../../../../org/apache/orc/impl/StringRedBlackTree.html" title="class in org.apache.orc.impl">StringRedBlackTree</a> dictionary</pre> +</li> +</ul> +<a name="rows"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rows</h4> +<pre>protected final <a href="../../../../../org/apache/orc/impl/DynamicIntArray.html" title="class in org.apache.orc.impl">DynamicIntArray</a> rows</pre> +</li> +</ul> +<a name="directStreamOutput"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>directStreamOutput</h4> +<pre>protected final <a href="../../../../../org/apache/orc/impl/PositionedOutputStream.html" title="class in org.apache.orc.impl">PositionedOutputStream</a> directStreamOutput</pre> +</li> +</ul> +<a name="useDictionaryEncoding"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>useDictionaryEncoding</h4> +<pre>protected boolean useDictionaryEncoding</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeStripe</h4> +<pre>public void writeStripe(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter.Builder</a> builder, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics.Builder</a> stats, + int requiredIndexEntries) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">TreeWriter</a></code></span></div> +<div class="block">Write the stripe out to the file.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>builder</code> - the stripe footer that contains the information about the + layout of the stripe. The TreeWriterBase is required to update + the footer with its information.</dd> +<dd><code>stats</code> - the stripe statistics information</dd> +<dd><code>requiredIndexEntries</code> - the number of index entries that are + required. this is to check to make sure the + row index is well formed.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="createRowIndexEntry--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRowIndexEntry</h4> +<pre>public void createRowIndexEntry() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">This method doesn't call the super method, because unlike most of the + other TreeWriters, this one can't record the position in the streams + until the stripe is being flushed. Therefore it saves all of the entries + and augments them with the final information as the stripe is written.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#createRowIndexEntry--">createRowIndexEntry</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createRowIndexEntry--">createRowIndexEntry</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="estimateMemory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>estimateMemory</h4> +<pre>public long estimateMemory()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#estimateMemory--">TreeWriterBase</a></code></span></div> +<div class="block">Estimate how much memory the writer is consuming excluding the streams.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#estimateMemory--">estimateMemory</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#estimateMemory--">estimateMemory</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of bytes.</dd> +</dl> +</li> +</ul> +<a name="getRawDataSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRawDataSize</h4> +<pre>public long getRawDataSize()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#getRawDataSize--">TreeWriter</a></code></span></div> +<div class="block">Estimate the memory used if the file was read into Hive's Writable + types. This is used as an estimate for the query optimizer.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of bytes</dd> +</dl> +</li> +</ul> +<a name="flushStreams--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>flushStreams</h4> +<pre>public void flushStreams() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#flushStreams--">TreeWriter</a></code></span></div> +<div class="block">Flush the TreeWriter stream</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#flushStreams--">flushStreams</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#flushStreams--">flushStreams</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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/StringBaseTreeWriter.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/orc/impl/writer/MapTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/StringTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StringBaseTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StringBaseTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/orc/blob/c06fe4d1/site/api/orc-core/org/apache/orc/impl/writer/StringTreeWriter.html ---------------------------------------------------------------------- diff --git a/site/api/orc-core/org/apache/orc/impl/writer/StringTreeWriter.html b/site/api/orc-core/org/apache/orc/impl/writer/StringTreeWriter.html new file mode 100644 index 0000000..2249d1e --- /dev/null +++ b/site/api/orc-core/org/apache/orc/impl/writer/StringTreeWriter.html @@ -0,0 +1,325 @@ +<!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 (1.8.0_121) on Mon May 14 13:41:16 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StringTreeWriter (ORC Core 1.5.0 API)</title> +<meta name="date" content="2018-05-14"> +<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="StringTreeWriter (ORC Core 1.5.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/StringTreeWriter.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/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StringTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StringTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.orc.impl.writer.StringBaseTreeWriter">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.orc.impl.writer</div> +<h2 title="Class StringTreeWriter" class="title">Class StringTreeWriter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">org.apache.orc.impl.writer.TreeWriterBase</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer">org.apache.orc.impl.writer.StringBaseTreeWriter</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.orc.impl.writer.StringTreeWriter</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">StringTreeWriter</span> +extends <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer">StringBaseTreeWriter</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.orc.impl.writer.TreeWriter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.Factory.html" title="class in org.apache.orc.impl.writer">TreeWriter.Factory</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.orc.impl.writer.StringBaseTreeWriter"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer">StringBaseTreeWriter</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#dictionary">dictionary</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#directStreamOutput">directStreamOutput</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#lengthOutput">lengthOutput</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#rows">rows</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#useDictionaryEncoding">useDictionaryEncoding</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilter">bloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterEntry">bloomFilterEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterUtf8">bloomFilterUtf8</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createBloomFilter">createBloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#fileStatistics">fileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#id">id</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#indexStatistics">indexStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#isPresent">isPresent</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#rowIndexPosition">rowIndexPosition</a>, <a href="../../../../../org/apache/orc/impl/writer /TreeWriterBase.html#stripeColStatistics">stripeColStatistics</a></code></li> +</ul> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/orc/impl/writer/StringTreeWriter.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> vector, + int offset, + int length)</code> +<div class="block">Write the values from the given vector from offset for length elements.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.orc.impl.writer.StringBaseTreeWriter"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer">StringBaseTreeWriter</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#createRowIndexEntry--">createRowIndexEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#estimateMemory--">estimateMemory</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#flushStreams--">flushStreams</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#getRawDataSize--">getRawDataSize</a>, <a href="../../../../../org/apache/orc/impl/writer/StringBaseTreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndex--">getRowIndex</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndexEntry--">getRowIndexEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getStripeStatistics--">getStripeStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">updateFileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">writeFileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">writeRootBatch</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</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="writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeBatch</h4> +<pre>public void writeBatch(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> vector, + int offset, + int length) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">TreeWriterBase</a></code></span></div> +<div class="block">Write the values from the given vector from offset for length elements.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>vector</code> - the vector to write from</dd> +<dd><code>offset</code> - the first value from the vector to write</dd> +<dd><code>length</code> - the number of values from the vector to write</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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/StringTreeWriter.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/orc/impl/writer/StringBaseTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StringTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StringTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.orc.impl.writer.StringBaseTreeWriter">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/orc/blob/c06fe4d1/site/api/orc-core/org/apache/orc/impl/writer/StructTreeWriter.html ---------------------------------------------------------------------- diff --git a/site/api/orc-core/org/apache/orc/impl/writer/StructTreeWriter.html b/site/api/orc-core/org/apache/orc/impl/writer/StructTreeWriter.html new file mode 100644 index 0000000..ed5936d --- /dev/null +++ b/site/api/orc-core/org/apache/orc/impl/writer/StructTreeWriter.html @@ -0,0 +1,581 @@ +<!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 (1.8.0_121) on Mon May 14 13:41:16 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StructTreeWriter (ORC Core 1.5.0 API)</title> +<meta name="date" content="2018-05-14"> +<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="StructTreeWriter (ORC Core 1.5.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/StructTreeWriter.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/orc/impl/writer/StringTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/TimestampTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StructTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StructTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.orc.impl.writer</div> +<h2 title="Class StructTreeWriter" class="title">Class StructTreeWriter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">org.apache.orc.impl.writer.TreeWriterBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.orc.impl.writer.StructTreeWriter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">StructTreeWriter</span> +extends <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.orc.impl.writer.TreeWriter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.Factory.html" title="class in org.apache.orc.impl.writer">TreeWriter.Factory</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilter">bloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterEntry">bloomFilterEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#bloomFilterUtf8">bloomFilterUtf8</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createBloomFilter">createBloomFilter</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#fileStatistics">fileStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#id">id</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#indexStatistics">indexStatistics</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#isPresent">isPresent</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#rowIndexPosition">rowIndexPosition</a>, <a href="../../../../../org/apache/orc/impl/writer /TreeWriterBase.html#stripeColStatistics">stripeColStatistics</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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#StructTreeWriter-int-org.apache.orc.TypeDescription-org.apache.orc.impl.writer.WriterContext-boolean-">StructTreeWriter</a></span>(int columnId, + <a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="../../../../../org/apache/orc/impl/writer/WriterContext.html" title="interface in org.apache.orc.impl.writer">WriterContext</a> writer, + boolean nullable)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/orc/impl/writer/StructTreeWriter.html#createRowIndexEntry--">createRowIndexEntry</a></span>()</code> +<div class="block">Create a row index entry with the previous location and the current + index statistics.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#estimateMemory--">estimateMemory</a></span>()</code> +<div class="block">Estimate how much memory the writer is consuming excluding the streams.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#flushStreams--">flushStreams</a></span>()</code> +<div class="block">Flush the TreeWriter stream</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#getRawDataSize--">getRawDataSize</a></span>()</code> +<div class="block">Estimate the memory used if the file was read into Hive's Writable + types.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">updateFileStatistics</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics</a> stats)</code> +<div class="block">During a stripe append, we need to update the file statistics.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> vector, + int offset, + int length)</code> +<div class="block">Write the values from the given vector from offset for length elements.</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/orc/impl/writer/StructTreeWriter.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">writeFileStatistics</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Footer.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Footer.Builder</a> footer)</code> +<div class="block">Add the file statistics to the file footer.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">writeRootBatch</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/VectorizedRowBatch.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">VectorizedRowBatch</a> batch, + int offset, + int length)</code> +<div class="block">Handle the top level object write.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/StructTreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter.Builder</a> builder, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics.Builder</a> stats, + int requiredIndexEntries)</code> +<div class="block">Write the stripe out to the file.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.orc.impl.writer.<a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></h3> +<code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndex--">getRowIndex</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getRowIndexEntry--">getRowIndexEntry</a>, <a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#getStripeStatistics--">getStripeStatistics</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StructTreeWriter-int-org.apache.orc.TypeDescription-org.apache.orc.impl.writer.WriterContext-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StructTreeWriter</h4> +<pre>public StructTreeWriter(int columnId, + <a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="../../../../../org/apache/orc/impl/writer/WriterContext.html" title="interface in org.apache.orc.impl.writer">WriterContext</a> writer, + boolean nullable) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeRootBatch</h4> +<pre>public void writeRootBatch(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/VectorizedRowBatch.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">VectorizedRowBatch</a> batch, + int offset, + int length) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">TreeWriterBase</a></code></span></div> +<div class="block">Handle the top level object write. + + This default method is used for all types except structs, which are the + typical case. VectorizedRowBatch assumes the top level object is a + struct, so we use the first column for all other types.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">writeRootBatch</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeRootBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-int-int-">writeRootBatch</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>batch</code> - the batch to write from</dd> +<dd><code>offset</code> - the row to start on</dd> +<dd><code>length</code> - the number of rows to write</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBatch</h4> +<pre>public void writeBatch(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> vector, + int offset, + int length) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">TreeWriterBase</a></code></span></div> +<div class="block">Write the values from the given vector from offset for length elements.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeBatch-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">writeBatch</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>vector</code> - the vector to write from</dd> +<dd><code>offset</code> - the first value from the vector to write</dd> +<dd><code>length</code> - the number of values from the vector to write</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="createRowIndexEntry--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRowIndexEntry</h4> +<pre>public void createRowIndexEntry() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createRowIndexEntry--">TreeWriterBase</a></code></span></div> +<div class="block">Create a row index entry with the previous location and the current + index statistics. Also merges the index statistics into the file + statistics before they are cleared. Finally, it records the start of the + next index and ensures all of the children columns also create an entry.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#createRowIndexEntry--">createRowIndexEntry</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#createRowIndexEntry--">createRowIndexEntry</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeStripe</h4> +<pre>public void writeStripe(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter.Builder</a> builder, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics.Builder</a> stats, + int requiredIndexEntries) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">TreeWriter</a></code></span></div> +<div class="block">Write the stripe out to the file.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeStatistics.Builder-int-">writeStripe</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>builder</code> - the stripe footer that contains the information about the + layout of the stripe. The TreeWriterBase is required to update + the footer with its information.</dd> +<dd><code>stats</code> - the stripe statistics information</dd> +<dd><code>requiredIndexEntries</code> - the number of index entries that are + required. this is to check to make sure the + row index is well formed.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateFileStatistics</h4> +<pre>public void updateFileStatistics(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeStatistics.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeStatistics</a> stats)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">TreeWriter</a></code></span></div> +<div class="block">During a stripe append, we need to update the file statistics.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">updateFileStatistics</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#updateFileStatistics-org.apache.orc.OrcProto.StripeStatistics-">updateFileStatistics</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stats</code> - the statistics for the new stripe</dd> +</dl> +</li> +</ul> +<a name="estimateMemory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>estimateMemory</h4> +<pre>public long estimateMemory()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#estimateMemory--">TreeWriterBase</a></code></span></div> +<div class="block">Estimate how much memory the writer is consuming excluding the streams.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#estimateMemory--">estimateMemory</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#estimateMemory--">estimateMemory</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of bytes.</dd> +</dl> +</li> +</ul> +<a name="getRawDataSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRawDataSize</h4> +<pre>public long getRawDataSize()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#getRawDataSize--">TreeWriter</a></code></span></div> +<div class="block">Estimate the memory used if the file was read into Hive's Writable + types. This is used as an estimate for the query optimizer.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of bytes</dd> +</dl> +</li> +</ul> +<a name="writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeFileStatistics</h4> +<pre>public void writeFileStatistics(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Footer.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Footer.Builder</a> footer)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">TreeWriter</a></code></span></div> +<div class="block">Add the file statistics to the file footer.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">writeFileStatistics</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#writeFileStatistics-org.apache.orc.OrcProto.Footer.Builder-">writeFileStatistics</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>footer</code> - the file footer builder</dd> +</dl> +</li> +</ul> +<a name="flushStreams--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>flushStreams</h4> +<pre>public void flushStreams() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#flushStreams--">TreeWriter</a></code></span></div> +<div class="block">Flush the TreeWriter stream</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html#flushStreams--">flushStreams</a></code> in interface <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriter.html" title="interface in org.apache.orc.impl.writer">TreeWriter</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html#flushStreams--">flushStreams</a></code> in class <code><a href="../../../../../org/apache/orc/impl/writer/TreeWriterBase.html" title="class in org.apache.orc.impl.writer">TreeWriterBase</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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/StructTreeWriter.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/orc/impl/writer/StringTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/orc/impl/writer/TimestampTreeWriter.html" title="class in org.apache.orc.impl.writer"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/orc/impl/writer/StructTreeWriter.html" target="_top">Frames</a></li> +<li><a href="StructTreeWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.orc.impl.writer.TreeWriterBase">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>