UnionMapWriter (Apache Arrow Java Root POM 16.1.0 API)

java.lang.Object
- org.apache.arrow.vector.complex.impl.UnionListWriter
- - org.apache.arrow.vector.complex.impl.UnionMapWriter

All Implemented Interfaces:

AutoCloseable, Positionable, BaseWriter, BaseWriter.ListWriter, BaseWriter.MapWriter, BaseWriter.ScalarWriter, BaseWriter.StructWriter, BigIntWriter, BitWriter, DateDayWriter, DateMilliWriter, Decimal256Writer, DecimalWriter, DurationWriter, FieldWriter, FixedSizeBinaryWriter, Float2Writer, Float4Writer, Float8Writer, IntervalDayWriter, IntervalMonthDayNanoWriter, IntervalYearWriter, IntWriter, LargeVarBinaryWriter, LargeVarCharWriter, SmallIntWriter, TimeMicroWriter, TimeMilliWriter, TimeNanoWriter, TimeSecWriter, TimeStampMicroTZWriter, TimeStampMicroWriter, TimeStampMilliTZWriter, TimeStampMilliWriter, TimeStampNanoTZWriter, TimeStampNanoWriter, TimeStampSecTZWriter, TimeStampSecWriter, TinyIntWriter, UInt1Writer, UInt2Writer, UInt4Writer, UInt8Writer, VarBinaryWriter, VarCharWriter
```
public class UnionMapWriter
extends UnionListWriter
```
Writer for MapVectors. This extends UnionListWriter to simplify writing map entries to a list of struct elements, with "key" and "value" fields. The procedure for writing a map begin with startMap() followed by startEntry(). An entry is written by using the key() writer to write the key, then the value() writer to write a value. After writing the value, call endEntry() to complete the entry. Each map can have 1 or more entries. When done writing entries, call endMap() to complete the map.
NOTE: the MapVector can have NULL values by not writing to position. If a map is started with startMap(), then it must have a key written. The value of a map entry can be NULL by not using the value() writer.
Example to write the following map to position 5 of a vector
```
   // {
   //   1 -> 3,
   //   2 -> 4,
   //   3 -> NULL
   // }

   UnionMapWriter writer = ...

   writer.setPosition(5);
   writer.startMap();
   writer.startEntry();
   writer.key().integer().writeInt(1);
   writer.value().integer().writeInt(3);
   writer.endEntry();
   writer.startEntry();
   writer.key().integer().writeInt(2);
   writer.value().integer().writeInt(4);
   writer.endEntry();
   writer.startEntry();
   writer.key().integer().writeInt(3);
   writer.endEntry();
   writer.endMap();
 
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.arrow.vector.complex.writer.BaseWriter
  BaseWriter.ComplexWriter, BaseWriter.ListWriter, BaseWriter.MapWriter, BaseWriter.ScalarWriter, BaseWriter.StructOrListWriter, BaseWriter.StructWriter

Field Summary

Fields
Modifier and Type Field and Description

protected boolean addVectorAsNullable
- Fields inherited from class org.apache.arrow.vector.complex.impl.UnionListWriter
  vector, writer

Fields
Modifier and Type	Field and Description
`protected boolean`	`addVectorAsNullable`

Constructor Summary

Constructors
Constructor and Description

UnionMapWriter(MapVector vector)

Constructors
Constructor and Description
`UnionMapWriter(MapVector vector)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigIntWriter`	`bigInt()`
`BitWriter`	`bit()`
`void`	`copyReader(FieldReader reader)`
`void`	`copyReaderToField(String name, FieldReader reader)`
`DateDayWriter`	`dateDay()`
`DateMilliWriter`	`dateMilli()`
`DecimalWriter`	`decimal()`
`Decimal256Writer`	`decimal256()`
`void`	`endEntry()` Complete the map entry.
`void`	`endMap()` Complete the map.
`Float2Writer`	`float2()`
`Float4Writer`	`float4()`
`Float8Writer`	`float8()`
`int`	`getPosition()`
`IntWriter`	`integer()`
`IntervalDayWriter`	`intervalDay()`
`IntervalMonthDayNanoWriter`	`intervalMonthDayNano()`
`IntervalYearWriter`	`intervalYear()`
`boolean`	`isEmptyStruct()` This implementation returns `false`.
`UnionMapWriter`	`key()` Return the key writer that is used to write to the "key" field.
`LargeVarBinaryWriter`	`largeVarBinary()`
`LargeVarCharWriter`	`largeVarChar()`
`BaseWriter.ListWriter`	`list()`
`BaseWriter.MapWriter`	`map(boolean keysSorted)`
`void`	`setAddVectorAsNullable(boolean nullable)` Set flag to control the FieldType.nullable property when a writer creates a new vector.
`SmallIntWriter`	`smallInt()`
`void`	`startEntry()` Start a map entry that should be followed by calls to `key()` and `value()` writers.
`void`	`startMap()` Start writing a map that consists of 1 or more entries.
`BaseWriter.StructWriter`	`struct()`
`TimeMicroWriter`	`timeMicro()`
`TimeMilliWriter`	`timeMilli()`
`TimeNanoWriter`	`timeNano()`
`TimeSecWriter`	`timeSec()`
`TimeStampMicroWriter`	`timeStampMicro()`
`TimeStampMilliWriter`	`timeStampMilli()`
`TimeStampNanoWriter`	`timeStampNano()`
`TimeStampSecWriter`	`timeStampSec()`
`TinyIntWriter`	`tinyInt()`
`String`	`toString()`
`UInt1Writer`	`uInt1()`
`UInt2Writer`	`uInt2()`
`UInt4Writer`	`uInt4()`
`UInt8Writer`	`uInt8()`
`UnionMapWriter`	`value()` Return the value writer that is used to write to the "value" field.
`VarBinaryWriter`	`varBinary()`
`VarCharWriter`	`varChar()`
`void`	`writeBigEndianBytesToDecimal(byte[] value)`
`void`	`writeBigEndianBytesToDecimal256(byte[] value)`

Methods inherited from class org.apache.arrow.vector.complex.impl.UnionListWriter
allocate, bigInt, bit, clear, close, dateDay, dateMilli, decimal, decimal, decimal256, decimal256, duration, duration, duration, end, endList, fixedSizeBinary, fixedSizeBinary, fixedSizeBinary, float2, float4, float8, getField, getValueCapacity, integer, intervalDay, intervalMonthDayNano, intervalYear, largeVarBinary, largeVarChar, list, map, map, map, setPosition, setValueCount, smallInt, start, startList, struct, timeMicro, timeMilli, timeNano, timeSec, timeStampMicro, timeStampMicroTZ, timeStampMicroTZ, timeStampMicroTZ, timeStampMilli, timeStampMilliTZ, timeStampMilliTZ, timeStampMilliTZ, timeStampNano, timeStampNanoTZ, timeStampNanoTZ, timeStampNanoTZ, timeStampSec, timeStampSecTZ, timeStampSecTZ, timeStampSecTZ, tinyInt, uInt1, uInt2, uInt4, uInt8, varBinary, varChar, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeBigEndianBytesToDecimal, writeBigEndianBytesToDecimal256, writeBigInt, writeBit, writeDateDay, writeDateMilli, writeDecimal, writeDecimal, writeDecimal, writeDecimal256, writeDecimal256, writeDecimal256, writeDuration, writeFixedSizeBinary, writeFloat2, writeFloat4, writeFloat8, writeInt, writeIntervalDay, writeIntervalMonthDayNano, writeIntervalYear, writeLargeVarBinary, writeLargeVarBinary, writeLargeVarBinary, writeLargeVarBinary, writeLargeVarBinary, writeLargeVarChar, writeLargeVarChar, writeLargeVarChar, writeNull, writeSmallInt, writeTimeMicro, writeTimeMilli, writeTimeNano, writeTimeSec, writeTimeStampMicro, writeTimeStampMicroTZ, writeTimeStampMilli, writeTimeStampMilliTZ, writeTimeStampNano, writeTimeStampNanoTZ, writeTimeStampSec, writeTimeStampSecTZ, writeTinyInt, writeUInt1, writeUInt2, writeUInt4, writeUInt8, writeVarBinary, writeVarBinary, writeVarBinary, writeVarBinary, writeVarBinary, writeVarChar, writeVarChar, writeVarChar

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

Methods inherited from interface org.apache.arrow.vector.complex.Positionable
getPosition

- Field Detail
  - addVectorAsNullable
```
protected boolean addVectorAsNullable
```
- Constructor Detail
  - UnionMapWriter
```
public UnionMapWriter(MapVector vector)
```
- Method Detail
  - startMap
```
public void startMap()
```
    Start writing a map that consists of 1 or more entries.
    
    Specified by:
    
    startMap in interface BaseWriter.MapWriter
  - endMap
```
public void endMap()
```
    Complete the map.
    
    Specified by:
    
    endMap in interface BaseWriter.MapWriter
  - startEntry
```
public void startEntry()
```
    Start a map entry that should be followed by calls to key() and value() writers. Call endEntry() to complete the entry.
    
    Specified by:
    
    startEntry in interface BaseWriter.MapWriter
  - endEntry
```
public void endEntry()
```
    Complete the map entry.
    
    Specified by:
    
    endEntry in interface BaseWriter.MapWriter
  - key
```
public UnionMapWriter key()
```
    Return the key writer that is used to write to the "key" field.
    
    Specified by:
    
    key in interface BaseWriter.MapWriter
  - value
```
public UnionMapWriter value()
```
    Return the value writer that is used to write to the "value" field.
    
    Specified by:
    
    value in interface BaseWriter.MapWriter
  - tinyInt
```
public TinyIntWriter tinyInt()
```
    Specified by:
    
    tinyInt in interface BaseWriter.ListWriter
    
    Overrides:
    
    tinyInt in class UnionListWriter
  - uInt1
```
public UInt1Writer uInt1()
```
    Specified by:
    
    uInt1 in interface BaseWriter.ListWriter
    
    Overrides:
    
    uInt1 in class UnionListWriter
  - uInt2
```
public UInt2Writer uInt2()
```
    Specified by:
    
    uInt2 in interface BaseWriter.ListWriter
    
    Overrides:
    
    uInt2 in class UnionListWriter
  - smallInt
```
public SmallIntWriter smallInt()
```
    Specified by:
    
    smallInt in interface BaseWriter.ListWriter
    
    Overrides:
    
    smallInt in class UnionListWriter
  - float2
```
public Float2Writer float2()
```
    Specified by:
    
    float2 in interface BaseWriter.ListWriter
    
    Overrides:
    
    float2 in class UnionListWriter
  - integer
```
public IntWriter integer()
```
    Specified by:
    
    integer in interface BaseWriter.ListWriter
    
    Overrides:
    
    integer in class UnionListWriter
  - uInt4
```
public UInt4Writer uInt4()
```
    Specified by:
    
    uInt4 in interface BaseWriter.ListWriter
    
    Overrides:
    
    uInt4 in class UnionListWriter
  - float4
```
public Float4Writer float4()
```
    Specified by:
    
    float4 in interface BaseWriter.ListWriter
    
    Overrides:
    
    float4 in class UnionListWriter
  - dateDay
```
public DateDayWriter dateDay()
```
    Specified by:
    
    dateDay in interface BaseWriter.ListWriter
    
    Overrides:
    
    dateDay in class UnionListWriter
  - intervalYear
```
public IntervalYearWriter intervalYear()
```
    Specified by:
    
    intervalYear in interface BaseWriter.ListWriter
    
    Overrides:
    
    intervalYear in class UnionListWriter
  - timeSec
```
public TimeSecWriter timeSec()
```
    Specified by:
    
    timeSec in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeSec in class UnionListWriter
  - timeMilli
```
public TimeMilliWriter timeMilli()
```
    Specified by:
    
    timeMilli in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeMilli in class UnionListWriter
  - bigInt
```
public BigIntWriter bigInt()
```
    Specified by:
    
    bigInt in interface BaseWriter.ListWriter
    
    Overrides:
    
    bigInt in class UnionListWriter
  - uInt8
```
public UInt8Writer uInt8()
```
    Specified by:
    
    uInt8 in interface BaseWriter.ListWriter
    
    Overrides:
    
    uInt8 in class UnionListWriter
  - float8
```
public Float8Writer float8()
```
    Specified by:
    
    float8 in interface BaseWriter.ListWriter
    
    Overrides:
    
    float8 in class UnionListWriter
  - dateMilli
```
public DateMilliWriter dateMilli()
```
    Specified by:
    
    dateMilli in interface BaseWriter.ListWriter
    
    Overrides:
    
    dateMilli in class UnionListWriter
  - timeStampSec
```
public TimeStampSecWriter timeStampSec()
```
    Specified by:
    
    timeStampSec in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeStampSec in class UnionListWriter
  - timeStampMilli
```
public TimeStampMilliWriter timeStampMilli()
```
    Specified by:
    
    timeStampMilli in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeStampMilli in class UnionListWriter
  - timeStampMicro
```
public TimeStampMicroWriter timeStampMicro()
```
    Specified by:
    
    timeStampMicro in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeStampMicro in class UnionListWriter
  - timeStampNano
```
public TimeStampNanoWriter timeStampNano()
```
    Specified by:
    
    timeStampNano in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeStampNano in class UnionListWriter
  - timeMicro
```
public TimeMicroWriter timeMicro()
```
    Specified by:
    
    timeMicro in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeMicro in class UnionListWriter
  - timeNano
```
public TimeNanoWriter timeNano()
```
    Specified by:
    
    timeNano in interface BaseWriter.ListWriter
    
    Overrides:
    
    timeNano in class UnionListWriter
  - intervalDay
```
public IntervalDayWriter intervalDay()
```
    Specified by:
    
    intervalDay in interface BaseWriter.ListWriter
    
    Overrides:
    
    intervalDay in class UnionListWriter
  - intervalMonthDayNano
```
public IntervalMonthDayNanoWriter intervalMonthDayNano()
```
    Specified by:
    
    intervalMonthDayNano in interface BaseWriter.ListWriter
    
    Overrides:
    
    intervalMonthDayNano in class UnionListWriter
  - varBinary
```
public VarBinaryWriter varBinary()
```
    Specified by:
    
    varBinary in interface BaseWriter.ListWriter
    
    Overrides:
    
    varBinary in class UnionListWriter
  - varChar
```
public VarCharWriter varChar()
```
    Specified by:
    
    varChar in interface BaseWriter.ListWriter
    
    Overrides:
    
    varChar in class UnionListWriter
  - largeVarChar
```
public LargeVarCharWriter largeVarChar()
```
    Specified by:
    
    largeVarChar in interface BaseWriter.ListWriter
    
    Overrides:
    
    largeVarChar in class UnionListWriter
  - largeVarBinary
```
public LargeVarBinaryWriter largeVarBinary()
```
    Specified by:
    
    largeVarBinary in interface BaseWriter.ListWriter
    
    Overrides:
    
    largeVarBinary in class UnionListWriter
  - bit
```
public BitWriter bit()
```
    Specified by:
    
    bit in interface BaseWriter.ListWriter
    
    Overrides:
    
    bit in class UnionListWriter
  - decimal
```
public DecimalWriter decimal()
```
    Specified by:
    
    decimal in interface BaseWriter.ListWriter
    
    Overrides:
    
    decimal in class UnionListWriter
  - decimal256
```
public Decimal256Writer decimal256()
```
    Specified by:
    
    decimal256 in interface BaseWriter.ListWriter
    
    Overrides:
    
    decimal256 in class UnionListWriter
  - struct
```
public BaseWriter.StructWriter struct()
```
    Specified by:
    
    struct in interface BaseWriter.ListWriter
    
    Overrides:
    
    struct in class UnionListWriter
  - list
```
public BaseWriter.ListWriter list()
```
    Specified by:
    
    list in interface BaseWriter.ListWriter
    
    Overrides:
    
    list in class UnionListWriter
  - map
```
public BaseWriter.MapWriter map(boolean keysSorted)
```
    Specified by:
    
    map in interface BaseWriter.ListWriter
    
    Overrides:
    
    map in class UnionListWriter
  - setAddVectorAsNullable
```
public void setAddVectorAsNullable(boolean nullable)
```
    Set flag to control the FieldType.nullable property when a writer creates a new vector. If true then vectors created will be nullable, this is the default behavior. If false then vectors created will be non-nullable.
    
    Parameters:
    
    nullable - Whether or not to create nullable vectors (default behavior is true)
  - writeBigEndianBytesToDecimal256
```
public void writeBigEndianBytesToDecimal256(byte[] value)
```
    Specified by:
    
    writeBigEndianBytesToDecimal256 in interface Decimal256Writer
    
    See Also:
    
    Decimal256Writer.writeBigEndianBytesToDecimal256(byte[], ArrowType), Decimal256Writer.write(Decimal256Holder)
  - writeBigEndianBytesToDecimal
```
public void writeBigEndianBytesToDecimal(byte[] value)
```
    Specified by:
    
    writeBigEndianBytesToDecimal in interface DecimalWriter
    
    See Also:
    
    DecimalWriter.writeBigEndianBytesToDecimal(byte[], ArrowType), DecimalWriter.write(DecimalHolder)
  - isEmptyStruct
```
public boolean isEmptyStruct()
```
    This implementation returns false.
    Must be overridden by struct writers.
    
    Specified by:
    
    isEmptyStruct in interface BaseWriter.StructWriter
    
    Returns:
    
    whether the struct is empty
  - copyReader
```
public void copyReader(FieldReader reader)
```
    Specified by:
    
    copyReader in interface BaseWriter.ListWriter
  - copyReaderToField
```
public void copyReaderToField(String name,
                              FieldReader reader)
```
    Specified by:
    
    copyReaderToField in interface BaseWriter.StructWriter
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPosition
```
public int getPosition()
```
    Specified by:
    
    getPosition in interface Positionable

Class UnionMapWriter

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.vector.complex.writer.BaseWriter

Field Summary

Fields inherited from class org.apache.arrow.vector.complex.impl.UnionListWriter

Constructor Summary

Method Summary

Methods inherited from class org.apache.arrow.vector.complex.impl.UnionListWriter

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.arrow.vector.complex.Positionable

Field Detail

addVectorAsNullable

Constructor Detail

UnionMapWriter

Method Detail

startMap

endMap

startEntry

endEntry

key

value

tinyInt

uInt1

uInt2

smallInt

float2

integer

uInt4

float4

dateDay

intervalYear

timeSec

timeMilli

bigInt

uInt8

float8

dateMilli

timeStampSec

timeStampMilli

timeStampMicro

timeStampNano

timeMicro

timeNano

intervalDay

intervalMonthDayNano

varBinary

varChar

largeVarChar

largeVarBinary

bit

decimal

decimal256

struct

list

map

setAddVectorAsNullable

writeBigEndianBytesToDecimal256

writeBigEndianBytesToDecimal

isEmptyStruct

copyReader

copyReaderToField

toString

getPosition