com.facebook.presto.common.block

Class MapBlockBuilder

java.lang.Object

com.facebook.presto.common.block.AbstractMapBlock

com.facebook.presto.common.block.MapBlockBuilder

All Implemented Interfaces:

Block, BlockBuilder, UncheckedBlock

public class MapBlockBuilder
extends AbstractMapBlock
implements BlockBuilder

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.presto.common.block.AbstractMapBlock

AbstractMapBlock.HashTables

Field Summary

Fields inherited from class com.facebook.presto.common.block.AbstractMapBlock

logicalSizeInBytes

Constructor Summary

Constructors

Constructor and Description
MapBlockBuilder(Type keyType, Type valueType, MethodHandle keyBlockEquals, MethodHandle keyBlockHashCode, BlockBuilderStatus blockBuilderStatus, int expectedEntries)

Method Summary

Modifier and Type	Method and Description
BlockBuilder	appendNull() Returns a block that has an appended null at the end, no matter if the original block has null or not.
BlockBuilder	appendStructure(Block block) Append a struct to the block and close the entry.
BlockBuilder	appendStructureInternal(Block block, int position) Do not use this interface outside block package.
SingleMapBlockWriter	beginBlockEntry() Return a writer to the current entry.
void	beginDirectEntry() Recommended way to build a Map is to first call beginBlockEntry which returns a BlockBuilder On this returned BlockBuilder, write key and value alternatively and call closeEntry.
Block	build() Builds the block.
BlockBuilder	closeEntry() Closes the current entry.
BlockBuilder	closeEntryStrict(MethodHandle keyBlockEquals, MethodHandle keyBlockHashCode) This method will check duplicate keys and close entry.
protected void	ensureHashTableLoaded(MethodHandle keyBlockHashCode)
protected AbstractMapBlock.HashTables	getHashTables()
BlockBuilder	getKeyBlockBuilder()
protected boolean[]	getMapIsNull()
int	getOffsetBase() offset is entry-based, not position-based.
protected int[]	getOffsets() offset is entry-based, not position-based.
int	getPositionCount() Returns the number of positions in this block.
protected Block	getRawKeyBlock()
protected Block	getRawValueBlock()
long	getRetainedSizeInBytes() Returns the retained size of this block in memory, including over-allocations.
Block	getSingleValueBlock(int position) Gets the value at the specified position as a single element block.
long	getSizeInBytes() Returns the size of this block as if it was compacted, ignoring any over-allocations.
BlockBuilder	getValueBlockBuilder()
void	loadHashTables()
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
void	retainedBytesForEachPart(BiConsumer<Object,Long> consumer) consumer visits each of the internal data container and accepts the size for it.
String	toString()

Methods inherited from class com.facebook.presto.common.block.AbstractMapBlock

copyPositions, copyRegion, fixedSizeInBytesPerPosition, getApproximateRegionLogicalSizeInBytes, getBlock, getBlockUnchecked, getEncodingName, getEstimatedDataSizeForStats, getLogicalSizeInBytes, getPositionsSizeInBytes, getRegion, getRegionLogicalSizeInBytes, getRegionSizeInBytes, getSingleValueBlockInternal, isHashTablesPresent, isNull, isNullUnchecked, mayHaveNull, writePositionTo, writePositionTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getPositions, writeByte, writeBytes, writeInt, writeLong, writeShort

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, getPositionsSizeInBytes, getRegion, getRegionLogicalSizeInBytes, getRegionSizeInBytes, getShort, getSlice, getSliceLength, hash, isNull, mayHaveNull, writeBytesTo, writeBytesTo, writePositionTo, writePositionTo

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

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

Constructor Detail

MapBlockBuilder

public MapBlockBuilder(Type keyType,
                       Type valueType,
                       MethodHandle keyBlockEquals,
                       MethodHandle keyBlockHashCode,
                       BlockBuilderStatus blockBuilderStatus,
                       int expectedEntries)

Method Detail

getRawKeyBlock

protected Block getRawKeyBlock()

Specified by:

getRawKeyBlock in class AbstractMapBlock

getRawValueBlock

protected Block getRawValueBlock()

Specified by:

getRawValueBlock in class AbstractMapBlock

getHashTables

protected AbstractMapBlock.HashTables getHashTables()

Specified by:

getHashTables in class AbstractMapBlock

getOffsets

protected int[] getOffsets()

Description copied from class: AbstractMapBlock

offset is entry-based, not position-based. In other words, if offset[1] is 6, it means the first map has 6 key-value pairs, not 6 key/values (which would be 3 pairs).

Specified by:

getOffsets in class AbstractMapBlock

getOffsetBase

public int getOffsetBase()

Description copied from class: AbstractMapBlock

offset is entry-based, not position-based. (see getOffsets)

Specified by:

getOffsetBase in interface UncheckedBlock

Specified by:

getOffsetBase in class AbstractMapBlock

Returns:

the internal offset of the underlying data structure of this block

getMapIsNull

protected boolean[] getMapIsNull()

Specified by:

getMapIsNull in class AbstractMapBlock

getPositionCount

public int getPositionCount()

Description copied from interface: Block

Returns the number of positions in this block.

Specified by:

getPositionCount in interface Block

getSizeInBytes

public long getSizeInBytes()

Description copied from interface: Block

Returns the size of this block as if it was compacted, ignoring any over-allocations. For example, in dictionary blocks, this only counts each dictionary entry once, rather than each time a value is referenced.

Specified by:

getSizeInBytes in interface Block

getRetainedSizeInBytes

public long getRetainedSizeInBytes()

Description copied from interface: Block

Returns the retained size of this block in memory, including over-allocations. This method is called from the inner most execution loop and must be fast.

Specified by:

getRetainedSizeInBytes in interface Block

retainedBytesForEachPart

public void retainedBytesForEachPart(BiConsumer<Object,Long> consumer)

Description copied from interface: Block

consumer visits each of the internal data container and accepts the size for it. This method can be helpful in cases such as memory counting for internal data structure. Also, the method should be non-recursive, only visit the elements at the top level, and specifically should not call retainedBytesForEachPart on nested blocks consumer should be called at least once with the current block and must include the instance size of the current block

Specified by:

retainedBytesForEachPart in interface Block

getSingleValueBlock

public Block getSingleValueBlock(int position)

Description copied from interface: Block

Gets the value at the specified position as a single element block. The returned block should retain only the memory required for a single block.

This method is useful for operators that hold on to a single value without holding on to the entire block.

Specified by:

getSingleValueBlock in interface Block

getKeyBlockBuilder

public BlockBuilder getKeyBlockBuilder()

getValueBlockBuilder

public BlockBuilder getValueBlockBuilder()

beginDirectEntry

public void beginDirectEntry()

Recommended way to build a Map is to first call beginBlockEntry which returns a BlockBuilder On this returned BlockBuilder, write key and value alternatively and call closeEntry. This works well for Presto, but when using the writer externally outside of Presto as a library the caller of the library, can't produce vectorized code due to mixing of key and value blocks. This method beginDirectEntry along with exposing keyBlockBuilder and valueBlockBuilder addresses this concern. BenchmarkMapBlockBuilder shows that both approaches are comparable.

Specified by:

beginDirectEntry in interface BlockBuilder

beginBlockEntry

public SingleMapBlockWriter beginBlockEntry()

Description copied from interface: BlockBuilder

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.

Specified by:

beginBlockEntry in interface BlockBuilder

closeEntry

public BlockBuilder closeEntry()

Description copied from interface: BlockBuilder

Closes the current entry.

Specified by:

closeEntry in interface BlockBuilder

closeEntryStrict

public BlockBuilder closeEntryStrict(MethodHandle keyBlockEquals,
                                     MethodHandle keyBlockHashCode)
                              throws DuplicateMapKeyException,
                                     NotSupportedException

This method will check duplicate keys and close entry.

When duplicate keys are discovered, the block is guaranteed to be in a consistent state before DuplicateMapKeyException is thrown. In other words, one can continue to use this BlockBuilder.

Throws:

DuplicateMapKeyException

NotSupportedException

appendNull

public BlockBuilder appendNull()

Description copied from interface: Block

Returns a block that has an appended null at the end, no matter if the original block has null or not. The original block won't be modified.

Specified by:

appendNull in interface Block

Specified by:

appendNull in interface BlockBuilder

Overrides:

appendNull in class AbstractMapBlock

readPositionFrom

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

Description copied from interface: BlockBuilder

Read a single position from the input

Specified by:

readPositionFrom in interface BlockBuilder

build

public Block build()

Description copied from interface: BlockBuilder

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

Specified by:

build in interface BlockBuilder

toString

public String toString()

Overrides:

toString in class Object

appendStructure

public BlockBuilder appendStructure(Block block)

Description copied from interface: BlockBuilder

Append a struct to the block and close the entry.

Specified by:

appendStructure in interface BlockBuilder

appendStructureInternal

public BlockBuilder appendStructureInternal(Block block,
                                            int position)

Description copied from interface: BlockBuilder

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

Specified by:

appendStructureInternal in interface BlockBuilder

newBlockBuilderLike

public BlockBuilder newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus)

Description copied from interface: BlockBuilder

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

Specified by:

newBlockBuilderLike in interface BlockBuilder

newBlockBuilderLike

public BlockBuilder newBlockBuilderLike(BlockBuilderStatus blockBuilderStatus,
                                        int expectedEntries)

Description copied from interface: BlockBuilder

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

Specified by:

newBlockBuilderLike in interface BlockBuilder

loadHashTables

public void loadHashTables()

ensureHashTableLoaded

protected void ensureHashTableLoaded(MethodHandle keyBlockHashCode)

Specified by:

ensureHashTableLoaded in class AbstractMapBlock