OrcPipelineOutput (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.foundations.core.Bean
- - com.northconcepts.datapipeline.foundations.core.FoundationObject
  - - com.northconcepts.datapipeline.foundations.pipeline.PipelineObject
    - - com.northconcepts.datapipeline.foundations.pipeline.PipelineOutput
      - com.northconcepts.datapipeline.foundations.pipeline.output.FileSinkPipelineOutput
        
        com.northconcepts.datapipeline.orc.output.OrcPipelineOutput

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataWriterFactory, JavaCodeGenerator, Serializable
```
public class OrcPipelineOutput
extends FileSinkPipelineOutput
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
  internalId, internalName, log, TIMESTAMP_FORMAT
- Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
  SERIALIZED_CLASS_NAME, TYPE
- Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
  XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors
Constructor and Description

OrcPipelineOutput()

Constructors
Constructor and Description
`OrcPipelineOutput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrcPipelineOutput`	`addConfiguration(Map<String,String> configuration)` Sets the Orc configuration parameters.
`OrcPipelineOutput`	`addConfiguration(String key, String value)` Sets the Orc configuration parameters.
`DataWriter`	`createDataWriter()`
`OrcPipelineOutput`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`OrcPipelineOutput`	`fromXmlElement(Element pipelineOutputElement)`
`void`	`generateJavaCode(JavaCodeBuilder javaCodeBuilder)`
`int`	`getBatchSize()` Indicates the maximum number of records to buffer when writing ORC data (default 1024).
`int`	`getBigDecimalPrecision()` Returns default precision value for BigDecimal type of values.
`int`	`getBigDecimalScale()` Indicates the scale used when writing BigDecimal values (default 10).
`CompressionKind`	`getCompressionKind()` Indicates the compression used for writing (default NONE).
`Map<String,String>`	`getConfiguration()` Returns the Orc configuration parameters.
`FileSink`	`getFileSink()`
`String`	`getName()`
`RoundingMode`	`getRoundingMode()` Indicates the rounding algorithm used for all BigDecimal values (default is `RoundingMode.HALF_UP`).
`RowBatchVersion`	`getRowBatchVersion()` Returns `RowBatchVersion` to store ORC data.
`TypeDescription`	`getSchema()` Returns the schema used to write the file.
`boolean`	`isOverwrite()` Overwrites the file if true, otherwise, throws an exception if the file already exists.
`boolean`	`isUseTimestampInstant()` Indicates if `Instant`s should be used to store datetime values.
`boolean`	`isUTC()` Indicates if datetime values are adjusted to UTC.
`boolean`	`isWriteUuidAsString()` Indicates whether UUID values are written as strings or bytes.
`OrcPipelineOutput`	`setBatchSize(int batchSize)` Indicates the maximum number of records to buffer when writing ORC data (default 1024).
`OrcPipelineOutput`	`setBigDecimalPrecision(int bigDecimalPrecision)` Sets default precision value for BigDecimal type of values.
`OrcPipelineOutput`	`setBigDecimalScale(int bigDecimalScale)` Indicates the scale used when writing BigDecimal values (default 10).
`OrcPipelineOutput`	`setCompressionKind(CompressionKind compressionKind)` Indicates the compression used for writing (default NONE).
`OrcPipelineOutput`	`setFileSink(FileSink fileSink)`
`OrcPipelineOutput`	`setOverwrite(boolean overwrite)` Overwrites the file if true, otherwise, throws an exception if the file already exists.
`OrcPipelineOutput`	`setRoundingMode(RoundingMode roundingMode)` Indicates the rounding algorithm used for all BigDecimal values (default is `RoundingMode.HALF_UP`).
`OrcPipelineOutput`	`setRowBatchVersion(RowBatchVersion rowBatchVersion)` Sets `RowBatchVersion` to store ORC data.
`OrcPipelineOutput`	`setSchema(TypeDescription schema)` Sets the schema used to write the file.
`OrcPipelineOutput`	`setUseTimestampInstant(boolean useTimestampInstant)` Indicates if `Instant`s should be used to store datetime values.
`void`	`setUTC(boolean UTC)` Indicates if datetime values are adjusted to UTC.
`OrcPipelineOutput`	`setWriteUuidAsString(boolean writeUuidAsString)` Indicates whether UUID values are written as strings or bytes.
`Record`	`toRecord()`
`Element`	`toXmlElement(Document document)`

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.output.FileSinkPipelineOutput
generateSaveCode

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineOutput
getNestedPipelineOutput, getRootPipelineOutput

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean
toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable
newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

- Constructor Detail
  - OrcPipelineOutput
```
public OrcPipelineOutput()
```
- Method Detail
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class FileSinkPipelineOutput
  - getFileSink
```
public FileSink getFileSink()
```
    Specified by:
    
    getFileSink in class FileSinkPipelineOutput
  - setFileSink
```
public OrcPipelineOutput setFileSink(FileSink fileSink)
```
    Specified by:
    
    setFileSink in class FileSinkPipelineOutput
  - createDataWriter
```
public DataWriter createDataWriter()
```
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder javaCodeBuilder)
```
  - getSchema
```
public TypeDescription getSchema()
```
    Returns the schema used to write the file.
  - setSchema
```
public OrcPipelineOutput setSchema(TypeDescription schema)
```
    Sets the schema used to write the file.
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
    Returns the Orc configuration parameters.
  - addConfiguration
```
public OrcPipelineOutput addConfiguration(Map<String,String> configuration)
```
    Sets the Orc configuration parameters.
  - addConfiguration
```
public OrcPipelineOutput addConfiguration(String key,
                                          String value)
```
    Sets the Orc configuration parameters.
  - getBatchSize
```
public int getBatchSize()
```
    Indicates the maximum number of records to buffer when writing ORC data (default 1024).
  - setBatchSize
```
public OrcPipelineOutput setBatchSize(int batchSize)
```
    Indicates the maximum number of records to buffer when writing ORC data (default 1024).
  - isUseTimestampInstant
```
public boolean isUseTimestampInstant()
```
    Indicates if Instants should be used to store datetime values.
  - setUseTimestampInstant
```
public OrcPipelineOutput setUseTimestampInstant(boolean useTimestampInstant)
```
    Indicates if Instants should be used to store datetime values.
  - isOverwrite
```
public boolean isOverwrite()
```
    Overwrites the file if true, otherwise, throws an exception if the file already exists.
  - setOverwrite
```
public OrcPipelineOutput setOverwrite(boolean overwrite)
```
    Overwrites the file if true, otherwise, throws an exception if the file already exists.
  - isUTC
```
public boolean isUTC()
```
    Indicates if datetime values are adjusted to UTC.
  - setUTC
```
public void setUTC(boolean UTC)
```
    Indicates if datetime values are adjusted to UTC.
  - isWriteUuidAsString
```
public boolean isWriteUuidAsString()
```
    Indicates whether UUID values are written as strings or bytes. If set to false, UUID values will be written as bytes.
    
    Default value is true.
  - setWriteUuidAsString
```
public OrcPipelineOutput setWriteUuidAsString(boolean writeUuidAsString)
```
    Indicates whether UUID values are written as strings or bytes. If set to false, UUID values will be written as bytes.
    
    Default value is true.
  - getRowBatchVersion
```
public RowBatchVersion getRowBatchVersion()
```
    Returns RowBatchVersion to store ORC data. precision > TypeDescription.MAX_DECIMAL64_PRECISION (18) then DecimalColumnVector is used instead of Decimal64ColumnVector.
  - setRowBatchVersion
```
public OrcPipelineOutput setRowBatchVersion(RowBatchVersion rowBatchVersion)
```
    Sets RowBatchVersion to store ORC data. If BigDecimal value has precision > TypeDescription.MAX_DECIMAL64_PRECISION (18) then DecimalColumnVector is used instead of Decimal64ColumnVector.
  - getBigDecimalPrecision
```
public int getBigDecimalPrecision()
```
    Returns default precision value for BigDecimal type of values. Default value is HiveDecimal.MAX_PRECISION (38).
  - setBigDecimalPrecision
```
public OrcPipelineOutput setBigDecimalPrecision(int bigDecimalPrecision)
```
    Sets default precision value for BigDecimal type of values. Default value is HiveDecimal.MAX_PRECISION (38).
  - getBigDecimalScale
```
public int getBigDecimalScale()
```
    Indicates the scale used when writing BigDecimal values (default 10).
  - setBigDecimalScale
```
public OrcPipelineOutput setBigDecimalScale(int bigDecimalScale)
```
    Indicates the scale used when writing BigDecimal values (default 10).
  - getRoundingMode
```
public RoundingMode getRoundingMode()
```
    Indicates the rounding algorithm used for all BigDecimal values (default is RoundingMode.HALF_UP).
  - setRoundingMode
```
public OrcPipelineOutput setRoundingMode(RoundingMode roundingMode)
```
    Indicates the rounding algorithm used for all BigDecimal values (default is RoundingMode.HALF_UP).
  - getCompressionKind
```
public CompressionKind getCompressionKind()
```
    Indicates the compression used for writing (default NONE).
  - setCompressionKind
```
public OrcPipelineOutput setCompressionKind(CompressionKind compressionKind)
```
    Indicates the compression used for writing (default NONE).
  - toRecord
```
public Record toRecord()
```
    Specified by:
    
    toRecord in interface RecordSerializable
    
    Overrides:
    
    toRecord in class Bean
  - fromRecord
```
public OrcPipelineOutput fromRecord(Record source)
```
    Description copied from interface: RecordSerializable
    
    Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.
    
    Specified by:
    
    fromRecord in interface RecordSerializable
    
    Overrides:
    
    fromRecord in class PipelineOutput
    
    Returns:
    
    this instance.
  - toXmlElement
```
public Element toXmlElement(Document document)
```
    Specified by:
    
    toXmlElement in interface XmlSerializable
    
    Overrides:
    
    toXmlElement in class PipelineOutput
  - fromXmlElement
```
public OrcPipelineOutput fromXmlElement(Element pipelineOutputElement)
```

Class OrcPipelineOutput

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.output.FileSinkPipelineOutput

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineOutput

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

Constructor Detail

OrcPipelineOutput

Method Detail

getName

getFileSink

setFileSink

createDataWriter

generateJavaCode

getSchema

setSchema

getConfiguration

addConfiguration

addConfiguration

getBatchSize

setBatchSize

isUseTimestampInstant

setUseTimestampInstant

isOverwrite

setOverwrite

isUTC

setUTC

isWriteUuidAsString

setWriteUuidAsString

getRowBatchVersion

setRowBatchVersion

getBigDecimalPrecision

setBigDecimalPrecision

getBigDecimalScale

setBigDecimalScale

getRoundingMode

setRoundingMode

getCompressionKind

setCompressionKind

toRecord

fromRecord

toXmlElement

fromXmlElement