org.apache.orc.impl.writer

Class StructTreeWriter

java.lang.Object

org.apache.orc.impl.writer.TreeWriterBase

org.apache.orc.impl.writer.StructTreeWriter

All Implemented Interfaces:

TreeWriter

public class StructTreeWriter
extends TreeWriterBase

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.orc.impl.writer.TreeWriter

TreeWriter.Factory

Field Summary

Fields inherited from class org.apache.orc.impl.writer.TreeWriterBase

bloomFilter, bloomFilterEntry, bloomFilterUtf8, createBloomFilter, fileStatistics, id, indexStatistics, isPresent, rowIndexPosition, stripeColStatistics

Constructor Summary

Constructors

Constructor and Description
StructTreeWriter(int columnId, TypeDescription schema, WriterContext writer, boolean nullable)

Method Summary

Modifier and Type	Method and Description
void	createRowIndexEntry() Create a row index entry with the previous location and the current index statistics.
long	estimateMemory() Estimate how much memory the writer is consuming excluding the streams.
void	flushStreams() Flush the TreeWriter stream
long	getRawDataSize() Estimate the memory used if the file was read into Hive's Writable types.
void	updateFileStatistics(OrcProto.StripeStatistics stats) During a stripe append, we need to update the file statistics.
void	writeBatch(ColumnVector vector, int offset, int length) Write the values from the given vector from offset for length elements.
void	writeFileStatistics(OrcProto.Footer.Builder footer) Add the file statistics to the file footer.
void	writeRootBatch(VectorizedRowBatch batch, int offset, int length) Handle the top level object write.
void	writeStripe(OrcProto.StripeFooter.Builder builder, OrcProto.StripeStatistics.Builder stats, int requiredIndexEntries) Write the stripe out to the file.

Methods inherited from class org.apache.orc.impl.writer.TreeWriterBase

getRowIndex, getRowIndexEntry, getStripeStatistics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructTreeWriter

public StructTreeWriter(int columnId,
                        TypeDescription schema,
                        WriterContext writer,
                        boolean nullable)
                 throws IOException

Throws:

IOException

Method Detail

writeRootBatch

public void writeRootBatch(VectorizedRowBatch batch,
                           int offset,
                           int length)
                    throws IOException

Description copied from class: TreeWriterBase

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.

Specified by:

writeRootBatch in interface TreeWriter

Overrides:

writeRootBatch in class TreeWriterBase

Parameters:

batch - the batch to write from

offset - the row to start on

length - the number of rows to write

Throws:

IOException

writeBatch

public void writeBatch(ColumnVector vector,
                       int offset,
                       int length)
                throws IOException

Description copied from class: TreeWriterBase

Write the values from the given vector from offset for length elements.

Specified by:

writeBatch in interface TreeWriter

Overrides:

writeBatch in class TreeWriterBase

Parameters:

vector - the vector to write from

offset - the first value from the vector to write

length - the number of values from the vector to write

Throws:

IOException

createRowIndexEntry

public void createRowIndexEntry()
                         throws IOException

Description copied from class: TreeWriterBase

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.

Specified by:

createRowIndexEntry in interface TreeWriter

Overrides:

createRowIndexEntry in class TreeWriterBase

Throws:

IOException

writeStripe

public void writeStripe(OrcProto.StripeFooter.Builder builder,
                        OrcProto.StripeStatistics.Builder stats,
                        int requiredIndexEntries)
                 throws IOException

Description copied from interface: TreeWriter

Write the stripe out to the file.

Specified by:

writeStripe in interface TreeWriter

Overrides:

writeStripe in class TreeWriterBase

Parameters:

builder - the stripe footer that contains the information about the layout of the stripe. The TreeWriterBase is required to update the footer with its information.

stats - the stripe statistics information

requiredIndexEntries - the number of index entries that are required. this is to check to make sure the row index is well formed.

Throws:

IOException

updateFileStatistics

public void updateFileStatistics(OrcProto.StripeStatistics stats)

Description copied from interface: TreeWriter

During a stripe append, we need to update the file statistics.

Specified by:

updateFileStatistics in interface TreeWriter

Overrides:

updateFileStatistics in class TreeWriterBase

Parameters:

stats - the statistics for the new stripe

estimateMemory

public long estimateMemory()

Description copied from class: TreeWriterBase

Estimate how much memory the writer is consuming excluding the streams.

Specified by:

estimateMemory in interface TreeWriter

Overrides:

estimateMemory in class TreeWriterBase

Returns:

the number of bytes.

getRawDataSize

public long getRawDataSize()

Description copied from interface: TreeWriter

Estimate the memory used if the file was read into Hive's Writable types. This is used as an estimate for the query optimizer.

Returns:

the number of bytes

writeFileStatistics

public void writeFileStatistics(OrcProto.Footer.Builder footer)

Description copied from interface: TreeWriter

Add the file statistics to the file footer.

Specified by:

writeFileStatistics in interface TreeWriter

Overrides:

writeFileStatistics in class TreeWriterBase

Parameters:

footer - the file footer builder

flushStreams

public void flushStreams()
                  throws IOException

Description copied from interface: TreeWriter

Flush the TreeWriter stream

Specified by:

flushStreams in interface TreeWriter

Overrides:

flushStreams in class TreeWriterBase

Throws:

IOException