com.facebook.presto.common.block

Class VariableWidthBlockBuilder

java.lang.Object

com.facebook.presto.common.block.AbstractVariableWidthBlock

com.facebook.presto.common.block.VariableWidthBlockBuilder

All Implemented Interfaces:

Block, BlockBuilder, UncheckedBlock

public class VariableWidthBlockBuilder
extends AbstractVariableWidthBlock
implements BlockBuilder

Constructor Summary

Constructors

Constructor and Description
VariableWidthBlockBuilder(BlockBuilderStatus blockBuilderStatus, int expectedEntries, int expectedBytes)

Method Summary

Modifier and Type	Method and Description
BlockBuilder	appendNull() Appends a null value to the block.
Block	build() Builds the block.
BlockBuilder	closeEntry() Closes the current entry.
Block	copyPositions(int[] positions, int offset, int length) Returns a block containing the specified positions.
Block	copyRegion(int positionOffset, int length) Returns a block starting at the specified position and extends for the specified length.
byte	getByteUnchecked(int internalPosition) Gets a byte value at internalPosition - getOffsetBase().
int	getIntUnchecked(int internalPosition) Gets a little endian int value at internalPosition - getOffsetBase().
long	getLongUnchecked(int internalPosition) Gets a little endian long value at internalPosition - getOffsetBase().
long	getLongUnchecked(int internalPosition, int offset) Gets a little endian long at offset in the value at internalPosition - getOffsetBase().
int	getOffsetBase()
int	getPositionCount() Returns the number of positions in this block.
int	getPositionOffset(int position)
long	getPositionsSizeInBytes(boolean[] positions) Returns the size of of all positions marked true in the positions array.
io.airlift.slice.Slice	getRawSlice(int position)
Block	getRegion(int positionOffset, int length) Returns a block starting at the specified position and extends for the specified length.
long	getRegionSizeInBytes(int positionOffset, int length) Returns the size of block.getRegion(position, length).
long	getRetainedSizeInBytes() Returns the retained size of this block in memory, including over-allocations.
short	getShortUnchecked(int internalPosition) Gets a little endian short at value at internalPosition - getOffsetBase().
long	getSizeInBytes() Returns the size of this block as if it was compacted, ignoring any over-allocations.
int	getSliceLength(int position) Gets the length of the value at the position.
int	getSliceLengthUnchecked(int internalPosition) Gets the length of the slice value at internalPosition - getOffsetBase().
io.airlift.slice.Slice	getSliceUnchecked(int internalPosition, int offset, int length) Gets a slice with offset offset at internalPosition - getOffsetBase().
protected boolean	isEntryNull(int position)
boolean	isNullUnchecked(int internalPosition)
boolean	mayHaveNull() Is it possible the block may have a null value? If false, the block can not contain a null, but if true, the block may or may not have a null.
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()
BlockBuilder	writeByte(int value) Write a byte to the current entry;
BlockBuilder	writeBytes(io.airlift.slice.Slice source, int sourceIndex, int length) Write a byte sequences to the current entry;
BlockBuilder	writeInt(int value) Write a int to the current entry;
BlockBuilder	writeLong(long value) Write a long to the current entry;
BlockBuilder	writeShort(int value) Write a short to the current entry;

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

bytesCompare, bytesEqual, checkReadablePosition, compareTo, equals, getByte, getEncodingName, getEstimatedDataSizeForStats, getInt, getLong, getLong, getShort, getSingleValueBlock, getSlice, hash, isNull, writeBytesTo, 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

appendStructure, appendStructureInternal, beginBlockEntry, getPositions

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

bytesCompare, bytesEqual, compareTo, equals, getApproximateRegionLogicalSizeInBytes, getBlock, getByte, getEncodingName, getEstimatedDataSizeForStats, getInt, getLoadedBlock, getLogicalSizeInBytes, getLong, getLong, getRegionLogicalSizeInBytes, getShort, getSingleValueBlock, getSlice, hash, isNull, writeBytesTo, writePositionTo, writePositionTo

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

getBlockUnchecked

Constructor Detail

VariableWidthBlockBuilder

public VariableWidthBlockBuilder(@Nullable
                                 BlockBuilderStatus blockBuilderStatus,
                                 int expectedEntries,
                                 int expectedBytes)

Method Detail

getPositionOffset

public int getPositionOffset(int position)

Specified by:

getPositionOffset in class AbstractVariableWidthBlock

getSliceLength

public int getSliceLength(int position)

Description copied from interface: Block

Gets the length of the value at the position. This method must be implemented if @{code getSlice} is implemented.

Specified by:

getSliceLength in interface Block

getRawSlice

public io.airlift.slice.Slice getRawSlice(int position)

Specified by:

getRawSlice in class AbstractVariableWidthBlock

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

getRegionSizeInBytes

public long getRegionSizeInBytes(int positionOffset,
                                 int length)

Description copied from interface: Block

Returns the size of block.getRegion(position, length). The method can be expensive. Do not use it outside an implementation of Block.

Specified by:

getRegionSizeInBytes in interface Block

getPositionsSizeInBytes

public long getPositionsSizeInBytes(boolean[] positions)

Description copied from interface: Block

Returns the size of of all positions marked true in the positions array. This is equivalent to multiple calls of block.getRegionSizeInBytes(position, length) where you mark all positions for the regions first.

Specified by:

getPositionsSizeInBytes 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

copyPositions

public Block copyPositions(int[] positions,
                           int offset,
                           int length)

Description copied from interface: Block

Returns a block containing the specified positions. Positions to copy are stored in a subarray within positions array that starts at offset and has length of length. All specified positions must be valid for this block.

The returned block must be a compact representation of the original block.

Specified by:

copyPositions in interface Block

writeByte

public BlockBuilder writeByte(int value)

Description copied from interface: BlockBuilder

Write a byte to the current entry;

Specified by:

writeByte in interface BlockBuilder

writeShort

public BlockBuilder writeShort(int value)

Description copied from interface: BlockBuilder

Write a short to the current entry;

Specified by:

writeShort in interface BlockBuilder

writeInt

public BlockBuilder writeInt(int value)

Description copied from interface: BlockBuilder

Write a int to the current entry;

Specified by:

writeInt in interface BlockBuilder

writeLong

public BlockBuilder writeLong(long value)

Description copied from interface: BlockBuilder

Write a long to the current entry;

Specified by:

writeLong in interface BlockBuilder

writeBytes

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

Description copied from interface: BlockBuilder

Write a byte sequences to the current entry;

Specified by:

writeBytes in interface BlockBuilder

closeEntry

public BlockBuilder closeEntry()

Description copied from interface: BlockBuilder

Closes the current entry.

Specified by:

closeEntry in interface BlockBuilder

appendNull

public BlockBuilder appendNull()

Description copied from interface: BlockBuilder

Appends a null value to the block.

Specified by:

appendNull in interface Block

Specified by:

appendNull in interface BlockBuilder

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

mayHaveNull

public boolean mayHaveNull()

Description copied from interface: Block

Is it possible the block may have a null value? If false, the block can not contain a null, but if true, the block may or may not have a null.

Specified by:

mayHaveNull in interface Block

isEntryNull

protected boolean isEntryNull(int position)

Specified by:

isEntryNull in class AbstractVariableWidthBlock

getRegion

public Block getRegion(int positionOffset,
                       int length)

Description copied from interface: Block

Returns a block starting at the specified position and extends for the specified length. The specified region must be entirely contained within this block.

The region can be a view over this block. If this block is released the region block may also be released. If the region block is released this block may also be released.

Specified by:

getRegion in interface Block

copyRegion

public Block copyRegion(int positionOffset,
                        int length)

Description copied from interface: Block

Returns a block starting at the specified position and extends for the specified length. The specified region must be entirely contained within this block.

The region returned must be a compact representation of the original block, unless their internal representation will be exactly the same. This method is useful for operators that hold on to a range of values without holding on to the entire block.

Specified by:

copyRegion in interface Block

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

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

toString

public String toString()

Overrides:

toString in class Object

getByteUnchecked

public byte getByteUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets a byte value at internalPosition - getOffsetBase().

Specified by:

getByteUnchecked in interface UncheckedBlock

getShortUnchecked

public short getShortUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets a little endian short at value at internalPosition - getOffsetBase().

Specified by:

getShortUnchecked in interface UncheckedBlock

getIntUnchecked

public int getIntUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets a little endian int value at internalPosition - getOffsetBase().

Specified by:

getIntUnchecked in interface UncheckedBlock

getLongUnchecked

public long getLongUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets a little endian long value at internalPosition - getOffsetBase().

Specified by:

getLongUnchecked in interface UncheckedBlock

getLongUnchecked

public long getLongUnchecked(int internalPosition,
                             int offset)

Description copied from interface: UncheckedBlock

Gets a little endian long at offset in the value at internalPosition - getOffsetBase().

Specified by:

getLongUnchecked in interface UncheckedBlock

getSliceUnchecked

public io.airlift.slice.Slice getSliceUnchecked(int internalPosition,
                                                int offset,
                                                int length)

Description copied from interface: UncheckedBlock

Gets a slice with offset offset at internalPosition - getOffsetBase().

Specified by:

getSliceUnchecked in interface UncheckedBlock

getSliceLengthUnchecked

public int getSliceLengthUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets the length of the slice value at internalPosition - getOffsetBase(). This method must be implemented if getSliceUnchecked is implemented.

Specified by:

getSliceLengthUnchecked in interface UncheckedBlock

isNullUnchecked

public boolean isNullUnchecked(int internalPosition)

Specified by:

isNullUnchecked in interface UncheckedBlock

Returns:

true if value at internalPosition - getOffsetBase() is null

getOffsetBase

public int getOffsetBase()

Specified by:

getOffsetBase in interface UncheckedBlock

Returns:

the internal offset of the underlying data structure of this block