UnionVector (Arrow Vectors 0.7.0 API)

java.lang.Object
- org.apache.arrow.vector.complex.UnionVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, FieldVector, ValueVector
```
public class UnionVector
extends Object
implements FieldVector
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class UnionVector.Accessor

class UnionVector.Mutator

Nested Classes
Modifier and Type	Class and Description
`class`	`UnionVector.Accessor`
`class`	`UnionVector.Mutator`

Constructor Summary

Constructors
Constructor and Description

UnionVector(String name, BufferAllocator allocator, CallBack callBack)

Constructors
Constructor and Description
`UnionVector(String name, BufferAllocator allocator, CallBack callBack)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldVector`	`addVector(FieldVector v)`
`void`	`allocateNew()` Allocate new buffers.
`boolean`	`allocateNewSafe()` Allocates new buffers.
`void`	`clear()` Release the underlying ArrowBuf and reset the ValueVector to empty.
`void`	`close()` Alternative to clear().
`void`	`copyFrom(int inIndex, int outIndex, UnionVector from)`
`void`	`copyFromSafe(int inIndex, int outIndex, UnionVector from)`
`UnionVector.Accessor`	`getAccessor()`
`BufferAllocator`	`getAllocator()`
`NullableBigIntVector`	`getBigIntVector()`
`NullableBitVector`	`getBitVector()`
`ArrowBuf[]`	`getBuffers(boolean clear)` Return the underlying buffers associated with this vector.
`int`	`getBufferSize()`
`int`	`getBufferSizeFor(int valueCount)` Returns the number of bytes that is used by this vector if it holds the given number of values.
`List<FieldVector>`	`getChildrenFromFields()` the returned list is the same size as the list passed to initializeChildrenFromFields
`ArrowBuf`	`getDataBuffer()` Gets the underlying buffer associated with data vector
`long`	`getDataBufferAddress()` Gets the starting address of the underlying buffer associated with data vector
`NullableDateDayVector`	`getDateDayVector()`
`NullableDateMilliVector`	`getDateMilliVector()`
`Field`	`getField()` Get information about how this field is materialized.
`List<ArrowBuf>`	`getFieldBuffers()` (same size as getFieldVectors() since it is their content)
`List<BufferBacked>`	`getFieldInnerVectors()`
`NullableFloat4Vector`	`getFloat4Vector()`
`NullableFloat8Vector`	`getFloat8Vector()`
`NullableIntervalDayVector`	`getIntervalDayVector()`
`NullableIntervalYearVector`	`getIntervalYearVector()`
`NullableIntVector`	`getIntVector()`
`ListVector`	`getList()`
`NullableMapVector`	`getMap()`
`Types.MinorType`	`getMinorType()`
`UnionVector.Mutator`	`getMutator()`
`ArrowBuf`	`getOffsetBuffer()` Gets the underlying buffer associated with offset vector
`long`	`getOffsetBufferAddress()` Gets the starting address of the underlying buffer associated with offset vector
`FieldReader`	`getReader()`
`NullableSmallIntVector`	`getSmallIntVector()`
`NullableTimeMicroVector`	`getTimeMicroVector()`
`NullableTimeMilliVector`	`getTimeMilliVector()`
`NullableTimeNanoVector`	`getTimeNanoVector()`
`NullableTimeSecVector`	`getTimeSecVector()`
`NullableTimeStampMicroVector`	`getTimeStampMicroVector()`
`NullableTimeStampMilliVector`	`getTimeStampMilliVector()`
`NullableTimeStampNanoVector`	`getTimeStampNanoVector()`
`NullableTimeStampSecVector`	`getTimeStampSecVector()`
`NullableTinyIntVector`	`getTinyIntVector()`
`TransferPair`	`getTransferPair(BufferAllocator allocator)` to transfer quota responsibility
`TransferPair`	`getTransferPair(String ref, BufferAllocator allocator)`
`TransferPair`	`getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)`
`int`	`getTypeValue(int index)`
`UInt1Vector`	`getTypeVector()`
`NullableUInt1Vector`	`getUInt1Vector()`
`NullableUInt2Vector`	`getUInt2Vector()`
`NullableUInt4Vector`	`getUInt4Vector()`
`NullableUInt8Vector`	`getUInt8Vector()`
`ArrowBuf`	`getValidityBuffer()` Gets the underlying buffer associated with validity vector
`long`	`getValidityBufferAddress()` Gets the starting address of the underlying buffer associated with validity vector
`int`	`getValueCapacity()` Returns the maximum number of values that can be stored in this vector instance.
`NullableVarBinaryVector`	`getVarBinaryVector()`
`NullableVarCharVector`	`getVarCharVector()`
`FieldWriter`	`getWriter()`
`void`	`initializeChildrenFromFields(List<Field> children)` Initializes the child vectors to be later loaded with loadBuffers
`Iterator<ValueVector>`	`iterator()`
`void`	`loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)` loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
`TransferPair`	`makeTransferPair(ValueVector target)` makes a new transfer pair used to transfer underlying buffers
`void`	`reAlloc()` Allocate new buffer with double capacity, and copy data into the new buffer.
`void`	`setInitialCapacity(int numRecords)` Set the initial record capacity

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - UnionVector
```
public UnionVector(String name,
                   BufferAllocator allocator,
                   CallBack callBack)
```
- Method Detail
  - getAllocator
```
public BufferAllocator getAllocator()
```
    Specified by:
    
    getAllocator in interface ValueVector
  - getMinorType
```
public Types.MinorType getMinorType()
```
    Specified by:
    
    getMinorType in interface ValueVector
  - initializeChildrenFromFields
```
public void initializeChildrenFromFields(List<Field> children)
```
    Description copied from interface: FieldVector
    
    Initializes the child vectors to be later loaded with loadBuffers
    
    Specified by:
    
    initializeChildrenFromFields in interface FieldVector
    
    Parameters:
    
    children - the schema
  - getChildrenFromFields
```
public List<FieldVector> getChildrenFromFields()
```
    Description copied from interface: FieldVector
    
    the returned list is the same size as the list passed to initializeChildrenFromFields
    
    Specified by:
    
    getChildrenFromFields in interface FieldVector
    
    Returns:
    
    the children according to schema (empty for primitive types)
  - loadFieldBuffers
```
public void loadFieldBuffers(ArrowFieldNode fieldNode,
                             List<ArrowBuf> ownBuffers)
```
    Description copied from interface: FieldVector
    
    loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
    
    Specified by:
    
    loadFieldBuffers in interface FieldVector
    
    Parameters:
    
    fieldNode - the fieldNode
    
    ownBuffers - the buffers for this Field (own buffers only, children not included)
  - getFieldBuffers
```
public List<ArrowBuf> getFieldBuffers()
```
    Description copied from interface: FieldVector
    
    (same size as getFieldVectors() since it is their content)
    
    Specified by:
    
    getFieldBuffers in interface FieldVector
    
    Returns:
    
    the buffers containing the data for this vector (ready for reading)
  - getFieldInnerVectors
```
public List<BufferBacked> getFieldInnerVectors()
```
    Specified by:
    
    getFieldInnerVectors in interface FieldVector
    
    Returns:
    
    the inner vectors for this field as defined by the TypeLayout
  - getValidityBufferAddress
```
public long getValidityBufferAddress()
```
    Description copied from interface: FieldVector
    
    Gets the starting address of the underlying buffer associated with validity vector
    
    Specified by:
    
    getValidityBufferAddress in interface FieldVector
    
    Returns:
    
    buffer address
  - getDataBufferAddress
```
public long getDataBufferAddress()
```
    Description copied from interface: FieldVector
    
    Gets the starting address of the underlying buffer associated with data vector
    
    Specified by:
    
    getDataBufferAddress in interface FieldVector
    
    Returns:
    
    buffer address
  - getOffsetBufferAddress
```
public long getOffsetBufferAddress()
```
    Description copied from interface: FieldVector
    
    Gets the starting address of the underlying buffer associated with offset vector
    
    Specified by:
    
    getOffsetBufferAddress in interface FieldVector
    
    Returns:
    
    buffer address
  - getValidityBuffer
```
public ArrowBuf getValidityBuffer()
```
    Description copied from interface: ValueVector
    
    Gets the underlying buffer associated with validity vector
    
    Specified by:
    
    getValidityBuffer in interface ValueVector
    
    Returns:
    
    buffer
  - getDataBuffer
```
public ArrowBuf getDataBuffer()
```
    Description copied from interface: ValueVector
    
    Gets the underlying buffer associated with data vector
    
    Specified by:
    
    getDataBuffer in interface ValueVector
    
    Returns:
    
    buffer
  - getOffsetBuffer
```
public ArrowBuf getOffsetBuffer()
```
    Description copied from interface: ValueVector
    
    Gets the underlying buffer associated with offset vector
    
    Specified by:
    
    getOffsetBuffer in interface ValueVector
    
    Returns:
    
    buffer
  - getMap
```
public NullableMapVector getMap()
```
  - getTinyIntVector
```
public NullableTinyIntVector getTinyIntVector()
```
  - getUInt1Vector
```
public NullableUInt1Vector getUInt1Vector()
```
  - getUInt2Vector
```
public NullableUInt2Vector getUInt2Vector()
```
  - getSmallIntVector
```
public NullableSmallIntVector getSmallIntVector()
```
  - getIntVector
```
public NullableIntVector getIntVector()
```
  - getUInt4Vector
```
public NullableUInt4Vector getUInt4Vector()
```
  - getFloat4Vector
```
public NullableFloat4Vector getFloat4Vector()
```
  - getDateDayVector
```
public NullableDateDayVector getDateDayVector()
```
  - getIntervalYearVector
```
public NullableIntervalYearVector getIntervalYearVector()
```
  - getTimeSecVector
```
public NullableTimeSecVector getTimeSecVector()
```
  - getTimeMilliVector
```
public NullableTimeMilliVector getTimeMilliVector()
```
  - getBigIntVector
```
public NullableBigIntVector getBigIntVector()
```
  - getUInt8Vector
```
public NullableUInt8Vector getUInt8Vector()
```
  - getFloat8Vector
```
public NullableFloat8Vector getFloat8Vector()
```
  - getDateMilliVector
```
public NullableDateMilliVector getDateMilliVector()
```
  - getTimeStampSecVector
```
public NullableTimeStampSecVector getTimeStampSecVector()
```
  - getTimeStampMilliVector
```
public NullableTimeStampMilliVector getTimeStampMilliVector()
```
  - getTimeStampMicroVector
```
public NullableTimeStampMicroVector getTimeStampMicroVector()
```
  - getTimeStampNanoVector
```
public NullableTimeStampNanoVector getTimeStampNanoVector()
```
  - getTimeMicroVector
```
public NullableTimeMicroVector getTimeMicroVector()
```
  - getTimeNanoVector
```
public NullableTimeNanoVector getTimeNanoVector()
```
  - getIntervalDayVector
```
public NullableIntervalDayVector getIntervalDayVector()
```
  - getVarBinaryVector
```
public NullableVarBinaryVector getVarBinaryVector()
```
  - getVarCharVector
```
public NullableVarCharVector getVarCharVector()
```
  - getBitVector
```
public NullableBitVector getBitVector()
```
  - getList
```
public ListVector getList()
```
  - getTypeValue
```
public int getTypeValue(int index)
```
  - getTypeVector
```
public UInt1Vector getTypeVector()
```
  - allocateNew
```
public void allocateNew()
                 throws OutOfMemoryException
```
    Description copied from interface: ValueVector
    
    Allocate new buffers. ValueVector implements logic to determine how much to allocate.
    
    Specified by:
    
    allocateNew in interface ValueVector
    
    Throws:
    
    OutOfMemoryException - Thrown if no memory can be allocated.
  - allocateNewSafe
```
public boolean allocateNewSafe()
```
    Description copied from interface: ValueVector
    
    Allocates new buffers. ValueVector implements logic to determine how much to allocate.
    
    Specified by:
    
    allocateNewSafe in interface ValueVector
    
    Returns:
    
    Returns true if allocation was successful.
  - reAlloc
```
public void reAlloc()
```
    Description copied from interface: ValueVector
    
    Allocate new buffer with double capacity, and copy data into the new buffer. Replace vector's buffer with new buffer, and release old one
    
    Specified by:
    
    reAlloc in interface ValueVector
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords)
```
    Description copied from interface: ValueVector
    
    Set the initial record capacity
    
    Specified by:
    
    setInitialCapacity in interface ValueVector
    
    Parameters:
    
    numRecords - the initial record capacity.
  - getValueCapacity
```
public int getValueCapacity()
```
    Description copied from interface: ValueVector
    
    Returns the maximum number of values that can be stored in this vector instance.
    
    Specified by:
    
    getValueCapacity in interface ValueVector
    
    Returns:
    
    the maximum number of values that can be stored in this vector instance.
  - close
```
public void close()
```
    Description copied from interface: ValueVector
    
    Alternative to clear(). Allows use as an AutoCloseable in try-with-resources.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface ValueVector
  - clear
```
public void clear()
```
    Description copied from interface: ValueVector
    
    Release the underlying ArrowBuf and reset the ValueVector to empty.
    
    Specified by:
    
    clear in interface ValueVector
  - getField
```
public Field getField()
```
    Description copied from interface: ValueVector
    
    Get information about how this field is materialized.
    
    Specified by:
    
    getField in interface ValueVector
    
    Returns:
    
    the field corresponding to this vector
  - getTransferPair
```
public TransferPair getTransferPair(BufferAllocator allocator)
```
    Description copied from interface: ValueVector
    
    to transfer quota responsibility
    
    Specified by:
    
    getTransferPair in interface ValueVector
    
    Parameters:
    
    allocator - the target allocator
    
    Returns:
    
    a transfer pair, creating a new target vector of the same type.
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)
```
    Specified by:
    
    getTransferPair in interface ValueVector
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)
```
    Specified by:
    
    getTransferPair in interface ValueVector
  - makeTransferPair
```
public TransferPair makeTransferPair(ValueVector target)
```
    Description copied from interface: ValueVector
    
    makes a new transfer pair used to transfer underlying buffers
    
    Specified by:
    
    makeTransferPair in interface ValueVector
    
    Parameters:
    
    target - the target for the transfer
    
    Returns:
    
    a new transfer pair that is used to transfer underlying buffers into the target vector.
  - copyFrom
```
public void copyFrom(int inIndex,
                     int outIndex,
                     UnionVector from)
```
  - copyFromSafe
```
public void copyFromSafe(int inIndex,
                         int outIndex,
                         UnionVector from)
```
  - addVector
```
public FieldVector addVector(FieldVector v)
```
  - getAccessor
```
public UnionVector.Accessor getAccessor()
```
    Specified by:
    
    getAccessor in interface ValueVector
    
    Returns:
    
    an accessor that is used to read from this vector instance.
  - getMutator
```
public UnionVector.Mutator getMutator()
```
    Specified by:
    
    getMutator in interface ValueVector
    
    Returns:
    
    an mutator that is used to write to this vector instance.
  - getReader
```
public FieldReader getReader()
```
    Specified by:
    
    getReader in interface ValueVector
    
    Returns:
    
    a field reader that supports reading values from this vector.
  - getWriter
```
public FieldWriter getWriter()
```
  - getBufferSize
```
public int getBufferSize()
```
    Specified by:
    
    getBufferSize in interface ValueVector
    
    Returns:
    
    the number of bytes that is used by this vector instance.
  - getBufferSizeFor
```
public int getBufferSizeFor(int valueCount)
```
    Description copied from interface: ValueVector
    
    Returns the number of bytes that is used by this vector if it holds the given number of values. The result will be the same as if Mutator.setValueCount() were called, followed by calling getBufferSize(), but without any of the closing side-effects that setValueCount() implies wrt finishing off the population of a vector. Some operations might wish to use this to determine how much memory has been used by a vector so far, even though it is not finished being populated.
    
    Specified by:
    
    getBufferSizeFor in interface ValueVector
    
    Parameters:
    
    valueCount - the number of values to assume this vector contains
    
    Returns:
    
    the buffer size if this vector is holding valueCount values
  - getBuffers
```
public ArrowBuf[] getBuffers(boolean clear)
```
    Description copied from interface: ValueVector
    
    Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus external classes shouldn't hold a reference to it (unless they change it).
    
    Specified by:
    
    getBuffers in interface ValueVector
    
    Parameters:
    
    clear - Whether to clear vector before returning; the buffers will still be refcounted; but the returned array will be the only reference to them
    
    Returns:
    
    The underlying buffers that is used by this vector instance.
  - iterator
```
public Iterator<ValueVector> iterator()
```
    Specified by:
    
    iterator in interface Iterable<ValueVector>

Class UnionVector

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

UnionVector

Method Detail

getAllocator

getMinorType

initializeChildrenFromFields

getChildrenFromFields

loadFieldBuffers

getFieldBuffers

getFieldInnerVectors

getValidityBufferAddress

getDataBufferAddress

getOffsetBufferAddress

getValidityBuffer

getDataBuffer

getOffsetBuffer

getMap

getTinyIntVector

getUInt1Vector

getUInt2Vector

getSmallIntVector

getIntVector

getUInt4Vector

getFloat4Vector

getDateDayVector

getIntervalYearVector

getTimeSecVector

getTimeMilliVector

getBigIntVector

getUInt8Vector

getFloat8Vector

getDateMilliVector

getTimeStampSecVector

getTimeStampMilliVector

getTimeStampMicroVector

getTimeStampNanoVector

getTimeMicroVector

getTimeNanoVector

getIntervalDayVector

getVarBinaryVector

getVarCharVector

getBitVector

getList

getTypeValue

getTypeVector

allocateNew

allocateNewSafe

reAlloc

setInitialCapacity

getValueCapacity

close

clear

getField

getTransferPair

getTransferPair

getTransferPair

makeTransferPair

copyFrom

copyFromSafe

addVector

getAccessor

getMutator

getReader

getWriter

getBufferSize

getBufferSizeFor

getBuffers

iterator