com.facebook.presto.common.block

Interface BlockBuilder

All Superinterfaces:

Block, UncheckedBlock

All Known Implementing Classes:

AbstractVariableWidthBlockBuilder, ArrayBlockBuilder, ByteArrayBlockBuilder, Int128ArrayBlockBuilder, IntArrayBlockBuilder, LongArrayBlockBuilder, MapBlockBuilder, RowBlockBuilder, ShortArrayBlockBuilder, SingleArrayBlockWriter, SingleMapBlockWriter, SingleRowBlockWriter, VariableWidthBlockBuilder

public interface BlockBuilder
extends Block

Method Summary

Modifier and Type	Method and Description
BlockBuilder	appendNull() Appends a null value to the block.
default BlockBuilder	appendStructure(Block value) Append a struct to the block and close the entry.
default BlockBuilder	appendStructureInternal(Block block, int position) Do not use this interface outside block package.
default BlockBuilder	beginBlockEntry() Return a writer to the current entry.
default void	beginDirectEntry() Start a nested entry on the builder.
Block	build() Builds the block.
BlockBuilder	closeEntry() Closes the current entry.
default Block	getPositions(int[] visiblePositions, int offset, int length) Create a new block from the current materialized block by keeping the same elements only with respect to visiblePositions.
BlockBuilder	newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus) Creates a new block builder of the same type based on the current usage statistics of this block builder.
BlockBuilder	newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus, int expectedEntries) Creates a new block builder of the same type based on the expectedEntries and the current usage statistics of this block builder.
BlockBuilder	readPositionFrom(io.airlift.slice.SliceInput input) Read a single position from the input
default BlockBuilder	writeByte(int value) Write a byte to the current entry;
default BlockBuilder	writeBytes(io.airlift.slice.Slice source, int sourceIndex, int length) Write a byte sequences to the current entry;
default BlockBuilder	writeInt(int value) Write a int to the current entry;
default BlockBuilder	writeLong(long value) Write a long to the current entry;
default BlockBuilder	writeShort(int value) Write a short to the current entry;

Methods inherited from interface com.facebook.presto.common.block.Block

bytesCompare, bytesEqual, compareTo, copyPositions, copyRegion, equals, fixedSizeInBytesPerPosition, getApproximateRegionLogicalSizeInBytes, getBlock, getByte, getEncodingName, getEstimatedDataSizeForStats, getInt, getLoadedBlock, getLogicalSizeInBytes, getLong, getLong, getPositionCount, getPositionsSizeInBytes, getRegion, getRegionLogicalSizeInBytes, getRegionSizeInBytes, getRetainedSizeInBytes, getShort, getSingleValueBlock, getSizeInBytes, getSlice, getSliceLength, hash, isNull, mayHaveNull, retainedBytesForEachPart, writeBytesTo, writeBytesTo, writePositionTo, writePositionTo

Methods inherited from interface com.facebook.presto.common.block.UncheckedBlock

getBlockUnchecked, getByteUnchecked, getIntUnchecked, getLongUnchecked, getLongUnchecked, getOffsetBase, getShortUnchecked, getSliceLengthUnchecked, getSliceUnchecked, isNullUnchecked

Method Detail

writeByte

default BlockBuilder writeByte(int value)

Write a byte to the current entry;

writeShort

default BlockBuilder writeShort(int value)

Write a short to the current entry;

writeInt

default BlockBuilder writeInt(int value)

Write a int to the current entry;

writeLong

default BlockBuilder writeLong(long value)

Write a long to the current entry;

writeBytes

default BlockBuilder writeBytes(io.airlift.slice.Slice source,
                                int sourceIndex,
                                int length)

Write a byte sequences to the current entry;

beginBlockEntry

default BlockBuilder beginBlockEntry()

Return a writer to the current entry. The caller can operate on the returned caller to incrementally build the object. This is generally more efficient than building the object elsewhere and call writeObject afterwards because a large chunk of memory could potentially be unnecessarily copied in this process.

beginDirectEntry

default void beginDirectEntry()

Start a nested entry on the builder. beginBlockEntry returns an instance of block builder to write the nested entry. beginBlockEntry returns a blockBuilder instance and delegates the call to the nested entry block builder. beginDirectEntry does not allocate the blockBuilder, and it is the caller's responsibility to get the nested block builder and populate the nested block builder.

getPositions

default Block getPositions(int[] visiblePositions,
                           int offset,
                           int length)

Create a new block from the current materialized block by keeping the same elements only with respect to visiblePositions.

Specified by:

getPositions in interface Block

closeEntry

BlockBuilder closeEntry()

Closes the current entry.

appendNull

BlockBuilder appendNull()

Appends a null value to the block.

Specified by:

appendNull in interface Block

appendStructure

default BlockBuilder appendStructure(Block value)

Append a struct to the block and close the entry.

appendStructureInternal

default BlockBuilder appendStructureInternal(Block block,
                                             int position)

Do not use this interface outside block package. Instead, use Block.writePositionTo(BlockBuilder, position)

readPositionFrom

BlockBuilder readPositionFrom(io.airlift.slice.SliceInput input)

Read a single position from the input

build

Block build()

Builds the block. This method can be called multiple times.

newBlockBuilderLike

BlockBuilder newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus)

Creates a new block builder of the same type based on the current usage statistics of this block builder.

newBlockBuilderLike

BlockBuilder newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus,
                                 int expectedEntries)

Creates a new block builder of the same type based on the expectedEntries and the current usage statistics of this block builder.