org.apache.drill.exec.vector.accessor

Interface WriterPosition

All Known Subinterfaces:

OffsetVectorWriter, UnionWriterImpl.UnionShim, WriterEvents

All Known Implementing Classes:

AbstractArrayWriter, AbstractArrayWriter.BaseArrayWriter, AbstractFixedWidthWriter, AbstractFixedWidthWriter.BaseFixedWidthWriter, AbstractFixedWidthWriter.BaseIntWriter, AbstractScalarWriterImpl, AbstractTupleWriter, BaseScalarWriter, BaseVarWidthWriter, BitColumnWriter, DictEntryWriter, DummyArrayWriter, DummyArrayWriter.DummyOffsetVectorWriter, DummyDictWriter, DummyScalarWriter, EmptyListShim, ListWriterImpl, MapWriter, MapWriter.ArrayMapWriter, MapWriter.DummyArrayMapWriter, MapWriter.DummyMapWriter, MapWriter.SingleMapWriter, NullableScalarWriter, ObjectArrayWriter, ObjectDictWriter, OffsetVectorWriterImpl, RepeatedListWriter, RowSetLoaderImpl, RowSetWriterImpl, ScalarArrayWriter, SimpleListShim, TestDummyWriter.RootWriterFixture, UnionVectorShim, UnionWriterImpl

public interface WriterPosition

Position information about a writer used during vector overflow.

Method Summary

Modifier and Type	Method and Description
int	lastWriteIndex() Return the last write position in the vector.
int	rowStartIndex() Position within the vector of the first value for the current row.
int	writeIndex() Current write index for the writer.

Method Detail

rowStartIndex

int rowStartIndex()

Position within the vector of the first value for the current row. Note that this is always the first value for the row, even for a writer deeply nested within a hierarchy of arrays. (The first position for the current array is not exposed in this API.)

Returns:

the vector offset of the first value for the current row

lastWriteIndex

int lastWriteIndex()

Return the last write position in the vector. This may be the same as the writer index position (if the vector was written at that point), or an earlier point. In either case, this value points to the last valid value in the vector.

Returns:

index of the last valid value in the vector

writeIndex

int writeIndex()

Current write index for the writer. This is the global array location for arrays, same as the row index for top-level columns.

Returns:

current write index