Decimal64TreeWriter (ORC Core 1.6.6 API)
Date: 2021-01-13

org.apache.orc.impl.writer

## Class Decimal64TreeWriter

- java.lang.Object
- - org.apache.orc.impl.writer.TreeWriterBase
  - - org.apache.orc.impl.writer.Decimal64TreeWriter

- All Implemented Interfaces:
    TreeWriter

      public class Decimal64TreeWriter
      extends TreeWriterBase

  Writer for short decimals in ORCv2.

- - ### 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, context, createBloomFilter, encryption, fileStatistics, id, indexStatistics, isPresent, rowIndexPosition, schema, stripeColStatistics`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Decimal64TreeWriter(TypeDescription schema, WriterEncryptionVariant encryption, WriterContext writer)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `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` | `prepareStripe(int stripeId)` Set up for the next stripe.
    `void` | `writeBatch(ColumnVector vector, int offset, int length)` Write the values from the given vector from offset for length elements.
    `void` | `writeStripe(int requiredIndexEntries)` Write the stripe out to the file.

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

      `addStripeStatistics, createRowIndexEntry, getCurrentStatistics, getRowIndex, getRowIndexEntry, getStripeStatistics, writeFileStatistics, writeRootBatch`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### Decimal64TreeWriter

          public Decimal64TreeWriter(TypeDescription schema,
                                     WriterEncryptionVariant encryption,
                                     WriterContext writer)
                              throws IOException

      Throws:
        `IOException`

  - ### Method Detail

    - #### 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`

    - #### writeStripe

          public void writeStripe(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:
        `requiredIndexEntries` - the number of index entries that are required. this is to check to make sure the row index is well formed.
      Throws:
        `IOException`

    - #### 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

    - #### 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`

    - #### prepareStripe

          public void prepareStripe(int stripeId)

      Description copied from interface: `TreeWriter`
      Set up for the next stripe.
      Specified by:
        `prepareStripe` in interface `TreeWriter`
      Overrides:
        `prepareStripe` in class `TreeWriterBase`
      Parameters:
        `stripeId` - the next stripe id

Copyright © 2013–2021 The Apache Software Foundation. All rights reserved.