Google Git
Sign in
apache / orc / f303be55d00a7929d74b8bdad73a80554226901b / . / site / api / orc-core / org / apache / orc / PhysicalWriter.html
blob: 4578b07d852ba08b9b4ee5b76631238a4a2fd5bd [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 (1.8.0_252) on Sun Apr 26 20:47:05 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PhysicalWriter (ORC Core 1.6.3 API)</title>
<meta name="date" content="2020-04-26">
<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="PhysicalWriter (ORC Core 1.6.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":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/PhysicalWriter.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/OrcUtils.html" title="class in org.apache.orc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/PhysicalWriter.html" target="_top">Frames</a></li>
<li><a href="PhysicalWriter.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><a href="#nested.class.summary">Nested</a>&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.orc</div>
<h2 title="Interface PhysicalWriter" class="title">Interface PhysicalWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/orc/impl/PhysicalFsWriter.html" title="class in org.apache.orc.impl">PhysicalFsWriter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PhysicalWriter</span></pre>
<div class="block">This interface separates the physical layout of ORC files from the higher
level details.
This API is limited to being used by LLAP.</div>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc">PhysicalWriter.OutputReceiver</a></span></code>
<div class="block">The target of an output stream.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></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/PhysicalWriter.html#appendRawStripe-java.nio.ByteBuffer-org.apache.orc.OrcProto.StripeInformation.Builder-">appendRawStripe</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;stripe,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeInformation.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeInformation.Builder</a>&nbsp;dirEntry)</code>
<div class="block">Appends raw stripe data (e.g.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#close--">close</a></span>()</code>
<div class="block">Closes the writer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc">PhysicalWriter.OutputReceiver</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#createDataStream-org.apache.orc.impl.StreamName-">createDataStream</a></span>(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name)</code>
<div class="block">Create an OutputReceiver for the given name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#finalizeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeInformation.Builder-">finalizeStripe</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>&nbsp;footer,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeInformation.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeInformation.Builder</a>&nbsp;dirEntry)</code>
<div class="block">Flushes the data in all the streams, spills them to disk, write out stripe
footer.</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/PhysicalWriter.html#flush--">flush</a></span>()</code>
<div class="block">Flushes the writer so that readers can see the preceeding postscripts.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#getFileBytes-int-org.apache.orc.impl.writer.WriterEncryptionVariant-">getFileBytes</a></span>(int&nbsp;column,
<a href="../../../org/apache/orc/impl/writer/WriterEncryptionVariant.html" title="class in org.apache.orc.impl.writer">WriterEncryptionVariant</a>&nbsp;variant)</code>
<div class="block">Get the number of bytes for a file in a givem column.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/orc/impl/writer/StreamOptions.html" title="class in org.apache.orc.impl.writer">StreamOptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#getStreamOptions--">getStreamOptions</a></span>()</code>
<div class="block">Get the unencrypted stream options for this file.</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/PhysicalWriter.html#writeBloomFilter-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.BloomFilterIndex.Builder-">writeBloomFilter</a></span>(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.BloomFilterIndex.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.BloomFilterIndex.Builder</a>&nbsp;bloom)</code>
<div class="block">Write a bloom filter index in the given stream name.</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/PhysicalWriter.html#writeFileFooter-org.apache.orc.OrcProto.Footer.Builder-">writeFileFooter</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>&nbsp;builder)</code>
<div class="block">Writes out the file footer.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#writeFileMetadata-org.apache.orc.OrcProto.Metadata.Builder-">writeFileMetadata</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Metadata.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Metadata.Builder</a>&nbsp;builder)</code>
<div class="block">Writes out the file metadata.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#writeHeader--">writeHeader</a></span>()</code>
<div class="block">Writes the header of the file, which consists of the magic "ORC" bytes.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#writeIndex-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.RowIndex.Builder-">writeIndex</a></span>(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.RowIndex.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.RowIndex.Builder</a>&nbsp;index)</code>
<div class="block">Write an index in the given stream name.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#writePostScript-org.apache.orc.OrcProto.PostScript.Builder-">writePostScript</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.PostScript.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.PostScript.Builder</a>&nbsp;builder)</code>
<div class="block">Writes out the postscript (including the size byte if needed).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/PhysicalWriter.html#writeStatistics-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.ColumnStatistics.Builder-">writeStatistics</a></span>(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnStatistics.Builder</a>&nbsp;statistics)</code>
<div class="block">Write a stripe or file statistics to the file.</div>
</td>
</tr>
</table>
</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="writeHeader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeHeader</h4>
<pre>void&nbsp;writeHeader()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes the header of the file, which consists of the magic "ORC" bytes.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="createDataStream-org.apache.orc.impl.StreamName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDataStream</h4>
<pre><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc">PhysicalWriter.OutputReceiver</a>&nbsp;createDataStream(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Create an OutputReceiver for the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writeIndex-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.RowIndex.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeIndex</h4>
<pre>void&nbsp;writeIndex(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.RowIndex.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.RowIndex.Builder</a>&nbsp;index)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Write an index in the given stream name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the stream</dd>
<dd><code>index</code> - the bloom filter to write</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writeBloomFilter-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.BloomFilterIndex.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeBloomFilter</h4>
<pre>void&nbsp;writeBloomFilter(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.BloomFilterIndex.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.BloomFilterIndex.Builder</a>&nbsp;bloom)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Write a bloom filter index in the given stream name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the stream</dd>
<dd><code>bloom</code> - the bloom filter to write</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="finalizeStripe-org.apache.orc.OrcProto.StripeFooter.Builder-org.apache.orc.OrcProto.StripeInformation.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finalizeStripe</h4>
<pre>void&nbsp;finalizeStripe(<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>&nbsp;footer,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeInformation.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeInformation.Builder</a>&nbsp;dirEntry)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Flushes the data in all the streams, spills them to disk, write out stripe
footer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>footer</code> - Stripe footer to be updated with relevant data and written out.</dd>
<dd><code>dirEntry</code> - File metadata entry for the stripe, to be updated with
relevant data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writeStatistics-org.apache.orc.impl.StreamName-org.apache.orc.OrcProto.ColumnStatistics.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeStatistics</h4>
<pre>void&nbsp;writeStatistics(<a href="../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnStatistics.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnStatistics.Builder</a>&nbsp;statistics)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Write a stripe or file statistics to the file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the stream</dd>
<dd><code>statistics</code> - the statistics to write</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writeFileMetadata-org.apache.orc.OrcProto.Metadata.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeFileMetadata</h4>
<pre>void&nbsp;writeFileMetadata(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Metadata.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Metadata.Builder</a>&nbsp;builder)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes out the file metadata.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - Metadata builder to finalize and write.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writeFileFooter-org.apache.orc.OrcProto.Footer.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeFileFooter</h4>
<pre>void&nbsp;writeFileFooter(<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>&nbsp;builder)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes out the file footer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - Footer builder to finalize and write.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="writePostScript-org.apache.orc.OrcProto.PostScript.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writePostScript</h4>
<pre>long&nbsp;writePostScript(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.PostScript.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.PostScript.Builder</a>&nbsp;builder)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes out the postscript (including the size byte if needed).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - Postscript builder to finalize and write.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes the writer.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>void&nbsp;flush()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Flushes the writer so that readers can see the preceeding postscripts.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="appendRawStripe-java.nio.ByteBuffer-org.apache.orc.OrcProto.StripeInformation.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendRawStripe</h4>
<pre>void&nbsp;appendRawStripe(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;stripe,
<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeInformation.Builder.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeInformation.Builder</a>&nbsp;dirEntry)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Appends raw stripe data (e.g. for file merger).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stripe</code> - Stripe data buffer.</dd>
<dd><code>dirEntry</code> - File metadata entry for the stripe, to be updated with
relevant data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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="getFileBytes-int-org.apache.orc.impl.writer.WriterEncryptionVariant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileBytes</h4>
<pre>long&nbsp;getFileBytes(int&nbsp;column,
<a href="../../../org/apache/orc/impl/writer/WriterEncryptionVariant.html" title="class in org.apache.orc.impl.writer">WriterEncryptionVariant</a>&nbsp;variant)</pre>
<div class="block">Get the number of bytes for a file in a givem column.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>column</code> - column from which to get file size</dd>
<dd><code>variant</code> - the encryption variant to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of bytes for the given column</dd>
</dl>
</li>
</ul>
<a name="getStreamOptions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStreamOptions</h4>
<pre><a href="../../../org/apache/orc/impl/writer/StreamOptions.html" title="class in org.apache.orc.impl.writer">StreamOptions</a>&nbsp;getStreamOptions()</pre>
<div class="block">Get the unencrypted stream options for this file. This class needs the
stream options to write the indexes and footers.
Additionally, the LLAP CacheWriter wants to disable the generic compression.</div>
</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/PhysicalWriter.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/OrcUtils.html" title="class in org.apache.orc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/PhysicalWriter.html" target="_top">Frames</a></li>
<li><a href="PhysicalWriter.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><a href="#nested.class.summary">Nested</a>&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; 2013&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>