Module org.apache.arrow.vector

Package org.apache.arrow.vector.complex

Class AbstractContainerVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, DensityAwareVector, ValueVector

Direct Known Subclasses:

AbstractStructVector, DenseUnionVector, UnionVector

public abstract class AbstractContainerVector
extends Object
implements ValueVector, DensityAwareVector

Base class for composite vectors.

This class implements common functionality of composite vectors.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BufferAllocator	allocator
protected final CallBack	callBack
protected final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContainerVector(String name, BufferAllocator allocator, CallBack callBack)

Method Summary

Modifier and Type	Method	Description
abstract <T extends FieldVector> T	addOrGet(String name, FieldType fieldType, Class<T> clazz)
FixedSizeListVector	addOrGetFixedSizeList(String name, int listSize)
ListVector	addOrGetList(String name)
ListViewVector	addOrGetListView(String name)
MapVector	addOrGetMap(String name, boolean keysSorted)
StructVector	addOrGetStruct(String name)
UnionVector	addOrGetUnion(String name)
void	allocateNew()	Allocate new buffers.
void	close()	Clears out all underlying child vectors.
void	copyFrom(int fromIndex, int thisIndex, ValueVector from)	Copy a cell value from a particular index in source vector to a particular position in this vector.
void	copyFromSafe(int fromIndex, int thisIndex, ValueVector from)	Same as ValueVector.copyFrom(int, int, ValueVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
BufferAllocator	getAllocator()	Get the allocator associated with the vector.
FieldVector	getChild(String name)	Returns a ValueVector corresponding to the given field name if exists or null.
abstract <T extends FieldVector> T	getChild(String name, Class<T> clazz)
abstract VectorWithOrdinal	getChildVectorWithOrdinal(String name)
String	getName()	Gets the name of the vector.
abstract int	size()
protected boolean	supportsDirectRead()
String	toString()	Representation of vector suitable for debugging.
protected <T extends ValueVector> T	typeify(ValueVector v, Class<T> clazz)

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.DensityAwareVector

setInitialCapacity

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.arrow.vector.ValueVector

accept, allocateNewSafe, clear, getBuffers, getBufferSize, getBufferSizeFor, getDataBuffer, getField, getMinorType, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, getValueCapacity, getValueCount, hashCode, hashCode, isNull, makeTransferPair, reAlloc, reset, setInitialCapacity, setValueCount, validate, validateFull

Field Details

name

protected final String name

allocator

protected final BufferAllocator allocator

callBack

protected final CallBack callBack

Constructor Details

AbstractContainerVector

protected AbstractContainerVector(String name,
 BufferAllocator allocator,
 CallBack callBack)

Method Details

toString

public String toString()

Representation of vector suitable for debugging.

Overrides:

toString in class Object

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.

getAllocator

public BufferAllocator getAllocator()

Description copied from interface: ValueVector

Get the allocator associated with the vector. CAVEAT: Some ValueVector subclasses (e.g. NullVector) do not require an allocator for data storage and may return null.

Specified by:

getAllocator in interface ValueVector

Returns:

Returns nullable allocator.

getChild

public FieldVector getChild(String name)

Returns a ValueVector corresponding to the given field name if exists or null.

Parameters:

name - the name of the child to return

Returns:

the corresponding FieldVector

close

public void close()

Clears out all underlying child vectors.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ValueVector

typeify

protected <T extends ValueVector> T typeify(ValueVector v,
 Class<T> clazz)

supportsDirectRead

protected boolean supportsDirectRead()

size

public abstract int size()

addOrGet

public abstract <T extends FieldVector> T addOrGet(String name,
 FieldType fieldType,
 Class<T> clazz)

getChild

public abstract <T extends FieldVector> T getChild(String name,
 Class<T> clazz)

getChildVectorWithOrdinal

public abstract VectorWithOrdinal getChildVectorWithOrdinal(String name)

addOrGetStruct

public StructVector addOrGetStruct(String name)

addOrGetList

public ListVector addOrGetList(String name)

addOrGetListView

public ListViewVector addOrGetListView(String name)

addOrGetUnion

public UnionVector addOrGetUnion(String name)

addOrGetFixedSizeList

public FixedSizeListVector addOrGetFixedSizeList(String name,
 int listSize)

addOrGetMap

public MapVector addOrGetMap(String name,
 boolean keysSorted)

copyFrom

public void copyFrom(int fromIndex,
 int thisIndex,
 ValueVector from)

Description copied from interface: ValueVector

Copy a cell value from a particular index in source vector to a particular position in this vector.

Specified by:

copyFrom in interface ValueVector

Parameters:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

copyFromSafe

public void copyFromSafe(int fromIndex,
 int thisIndex,
 ValueVector from)

Description copied from interface: ValueVector

Same as ValueVector.copyFrom(int, int, ValueVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.

Specified by:

copyFromSafe in interface ValueVector

Parameters:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

getName

public String getName()

Description copied from interface: ValueVector

Gets the name of the vector.

Specified by:

getName in interface ValueVector

Returns:

the name of the vector.