com.facebook.presto.common.block

Class AbstractArrayBlock

java.lang.Object

com.facebook.presto.common.block.AbstractArrayBlock

All Implemented Interfaces:

Block, UncheckedBlock

Direct Known Subclasses:

ArrayBlock, ArrayBlockBuilder

public abstract class AbstractArrayBlock
extends Object
implements Block

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractArrayBlock.ArrayBlockFunction<T>

Constructor Summary

Constructors

Constructor and Description
AbstractArrayBlock()

Method Summary

Modifier and Type	Method and Description
Block	appendNull() Returns a block that has an appended null at the end, no matter if the original block has null or not.
<T> T	apply(AbstractArrayBlock.ArrayBlockFunction<T> function, int position)
protected void	checkReadablePosition(int position)
Block	copyPositions(int[] positions, int offset, int length) Returns a block containing the specified positions.
Block	copyRegion(int position, int length) Returns a block starting at the specified position and extends for the specified length.
OptionalInt	fixedSizeInBytesPerPosition() Returns the number of bytes (in terms of Block.getSizeInBytes()) required per position that this block contains, assuming that the number of bytes required is a known static quantity and not dependent on any particular specific position.
long	getApproximateRegionLogicalSizeInBytes(int position, int length) Returns the approximate logical size of block.getRegion(position, length).
Block	getBlock(int position) Gets a block in the value at position.
Block	getBlockUnchecked(int internalPosition) Gets a Block value at internalPosition - getOffsetBase().
String	getEncodingName() Get the encoding for this block.
long	getEstimatedDataSizeForStats(int position) Returns the estimated in memory data size for stats of position.
abstract int	getOffsetBase()
protected abstract int[]	getOffsets()
long	getPositionsSizeInBytes(boolean[] positions, int selectedArrayPositions) Returns the size of all positions marked true in the positions array.
protected abstract Block	getRawElementBlock()
Block	getRegion(int position, int length) Returns a block starting at the specified position and extends for the specified length.
long	getRegionLogicalSizeInBytes(int position, int length) Returns the size of block.getRegion(position, length).
long	getRegionSizeInBytes(int position, int length) Returns the size of block.getRegion(position, length).
protected Block	getSingleValueBlockInternal(int position)
protected abstract boolean[]	getValueIsNull()
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.
void	writePositionTo(int position, BlockBuilder blockBuilder) Appends the value at position to blockBuilder and close the entry.
void	writePositionTo(int position, io.airlift.slice.SliceOutput output) Appends the value at position to output.

Methods inherited from class java.lang.Object

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

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

bytesCompare, bytesEqual, compareTo, equals, getByte, getInt, getLoadedBlock, getLogicalSizeInBytes, getLong, getLong, getPositionCount, getPositions, getRetainedSizeInBytes, getShort, getSingleValueBlock, getSizeInBytes, getSlice, getSliceLength, hash, isNull, retainedBytesForEachPart, writeBytesTo, writeBytesTo

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

getByteUnchecked, getIntUnchecked, getLongUnchecked, getLongUnchecked, getShortUnchecked, getSliceLengthUnchecked, getSliceUnchecked

Constructor Detail

AbstractArrayBlock

public AbstractArrayBlock()

Method Detail

getRawElementBlock

protected abstract Block getRawElementBlock()

getOffsets

protected abstract int[] getOffsets()

getOffsetBase

public abstract int getOffsetBase()

Specified by:

getOffsetBase in interface UncheckedBlock

Returns:

the internal offset of the underlying data structure of this block

getValueIsNull

@Nullable
protected abstract boolean[] getValueIsNull()

Returns:

the underlying valueIsNull array, or null when all values are guaranteed to be non-null

getEncodingName

public String getEncodingName()

Description copied from interface: Block

Get the encoding for this block.

Specified by:

getEncodingName in interface Block

copyPositions

public final 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

getRegion

public Block getRegion(int position,
                       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

fixedSizeInBytesPerPosition

public OptionalInt fixedSizeInBytesPerPosition()

Description copied from interface: Block

Returns the number of bytes (in terms of Block.getSizeInBytes()) required per position that this block contains, assuming that the number of bytes required is a known static quantity and not dependent on any particular specific position. This allows for some complex block wrappings to potentially avoid having to call Block.getPositionsSizeInBytes(boolean[], int) which would require computing the specific positions selected

Specified by:

fixedSizeInBytesPerPosition in interface Block

Returns:

The size in bytes, per position, if this block type does not require specific position information to compute its size

getRegionSizeInBytes

public long getRegionSizeInBytes(int position,
                                 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

getRegionLogicalSizeInBytes

public long getRegionLogicalSizeInBytes(int position,
                                        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:

getRegionLogicalSizeInBytes in interface Block

getApproximateRegionLogicalSizeInBytes

public long getApproximateRegionLogicalSizeInBytes(int position,
                                                   int length)

Description copied from interface: Block

Returns the approximate logical size of block.getRegion(position, length). This method is faster than getRegionLogicalSizeInBytes(). For dictionary blocks, this counts the amortized flattened size of the included positions. For example, for a DictionaryBlock with 5 ids [1, 1, 1, 1, 1] and a dictionary of VariableWidthBlock with 3 elements of sizes [9, 5, 7], the result of getApproximateRegionLogicalSizeInBytes(0, 5) would be (9 + 5 + 7) / 3 * 5 = 35, while getRegionLogicalSizeInBytes(0, 5) would be 5 * 5 = 25.

Specified by:

getApproximateRegionLogicalSizeInBytes in interface Block

getPositionsSizeInBytes

public final long getPositionsSizeInBytes(boolean[] positions,
                                          int selectedArrayPositions)

Description copied from interface: Block

Returns the size 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

copyRegion

public Block copyRegion(int position,
                        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

getBlock

public Block getBlock(int position)

Description copied from interface: Block

Gets a block in the value at position.

Specified by:

getBlock in interface Block

Returns:

writePositionTo

public void writePositionTo(int position,
                            BlockBuilder blockBuilder)

Description copied from interface: Block

Appends the value at position to blockBuilder and close the entry.

Specified by:

writePositionTo in interface Block

writePositionTo

public void writePositionTo(int position,
                            io.airlift.slice.SliceOutput output)

Description copied from interface: Block

Appends the value at position to output.

Specified by:

writePositionTo in interface Block

getSingleValueBlockInternal

protected Block getSingleValueBlockInternal(int position)

getEstimatedDataSizeForStats

public long getEstimatedDataSizeForStats(int position)

Description copied from interface: Block

Returns the estimated in memory data size for stats of position. Do not use it for other purpose.

Specified by:

getEstimatedDataSizeForStats in interface Block

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

apply

public <T> T apply(AbstractArrayBlock.ArrayBlockFunction<T> function,
                   int position)

checkReadablePosition

protected final void checkReadablePosition(int position)

getBlockUnchecked

public Block getBlockUnchecked(int internalPosition)

Description copied from interface: UncheckedBlock

Gets a Block value at internalPosition - getOffsetBase().

Specified by:

getBlockUnchecked in interface UncheckedBlock

isNullUnchecked

public boolean isNullUnchecked(int internalPosition)

Specified by:

isNullUnchecked in interface UncheckedBlock

Returns:

true if value at internalPosition - getOffsetBase() is null

appendNull

public Block 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