Block (presto-common 0.278.1 API)

All Superinterfaces:

UncheckedBlock

All Known Subinterfaces:

BlockBuilder

All Known Implementing Classes:

AbstractArrayBlock, AbstractMapBlock, AbstractRowBlock, AbstractSingleArrayBlock, AbstractSingleMapBlock, AbstractSingleRowBlock, AbstractVariableWidthBlock, AbstractVariableWidthBlockBuilder, ArrayBlock, ArrayBlockBuilder, ByteArrayBlock, ByteArrayBlockBuilder, DictionaryBlock, Int128ArrayBlock, Int128ArrayBlockBuilder, IntArrayBlock, IntArrayBlockBuilder, LazyBlock, LongArrayBlock, LongArrayBlockBuilder, MapBlock, MapBlockBuilder, RowBlock, RowBlockBuilder, RunLengthEncodedBlock, ShortArrayBlock, ShortArrayBlockBuilder, SingleArrayBlockWriter, SingleMapBlock, SingleMapBlockWriter, SingleRowBlock, SingleRowBlockWriter, VariableWidthBlock, VariableWidthBlockBuilder
```
public interface Block
extends UncheckedBlock
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.
`default int`	`bytesCompare(int position, int offset, int length, io.airlift.slice.Slice otherSlice, int otherOffset, int otherLength)` Compares the byte sequences at `offset` in the value at `position` to the byte sequence at `otherOffset` in `otherSlice`.
`default boolean`	`bytesEqual(int position, int offset, io.airlift.slice.Slice otherSlice, int otherOffset, int length)` Is the byte sequences at `offset` in the value at `position` equal to the byte sequence at `otherOffset` in `otherSlice`.
`default int`	`compareTo(int leftPosition, int leftOffset, int leftLength, Block rightBlock, int rightPosition, int rightOffset, int rightLength)` Compares the byte sequences at `offset` in the value at `position` to the byte sequence at `otherOffset` in the value at `otherPosition` in `otherBlock`.
`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.
`default boolean`	`equals(int position, int offset, Block otherBlock, int otherPosition, int otherOffset, int length)` Is the byte sequences at `offset` in the value at `position` equal to the byte sequence at `otherOffset` in the value at `otherPosition` in `otherBlock`.
`OptionalInt`	`fixedSizeInBytesPerPosition()` Returns the number of bytes (in terms of `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.
`default long`	`getApproximateRegionLogicalSizeInBytes(int position, int length)` Returns the approximate logical size of `block.getRegion(position, length)`.
`default Block`	`getBlock(int position)` Gets a block in the value at `position`.
`default byte`	`getByte(int position)` Gets a byte in the value at `position`.
`String`	`getEncodingName()` Get the encoding for this block.
`long`	`getEstimatedDataSizeForStats(int position)` Returns the estimated in memory data size for stats of position.
`default int`	`getInt(int position)` Gets a little endian int in the value at `position`.
`default Block`	`getLoadedBlock()` Returns a block that assures all data is in memory.
`default long`	`getLogicalSizeInBytes()` Returns the size of the block contents, regardless of internal representation.
`default long`	`getLong(int position)` Gets a little endian long in the value at `position`.
`default long`	`getLong(int position, int offset)` Gets a little endian long at `offset` in the value at `position`.
`int`	`getPositionCount()` Returns the number of positions in this block.
`default Block`	`getPositions(int[] positions, int offset, int length)` Create a new block from the current block by keeping the same elements only with respect to `positions` that starts at `offset` and has length of `length`.
`long`	`getPositionsSizeInBytes(boolean[] positions, int usedPositionCount)` Returns the size of all positions marked true in the positions array.
`Block`	`getRegion(int positionOffset, int length)` Returns a block starting at the specified position and extends for the specified length.
`default 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)`.
`long`	`getRetainedSizeInBytes()` Returns the retained size of this block in memory, including over-allocations.
`default short`	`getShort(int position)` Gets a little endian short at in the value at `position`.
`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.
`default io.airlift.slice.Slice`	`getSlice(int position, int offset, int length)` Gets a slice at `offset` in the value at `position`.
`default int`	`getSliceLength(int position)` Gets the length of the value at the `position`.
`default long`	`hash(int position, int offset, int length)` Calculates the hash code the byte sequences at `offset` in the value at `position`.
`boolean`	`isNull(int position)` Is the specified position null?
`default 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`	`retainedBytesForEachPart(ObjLongConsumer<Object> consumer)` `consumer` visits each of the internal data container and accepts the size for it.
`default void`	`writeBytesTo(int position, int offset, int length, BlockBuilder blockBuilder)` Appends the byte sequences at `offset` in the value at `position` to `blockBuilder`.
`default void`	`writeBytesTo(int position, int offset, int length, io.airlift.slice.SliceOutput sliceOutput)` Appends the byte sequences at `offset` in the value at `position` to `sliceOutput`.
`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 interface com.facebook.presto.common.block.UncheckedBlock
getBlockUnchecked, getByteUnchecked, getIntUnchecked, getLongUnchecked, getLongUnchecked, getOffsetBase, getShortUnchecked, getSliceLengthUnchecked, getSliceUnchecked, isNullUnchecked

- Method Detail
  - getSliceLength
```
default int getSliceLength(int position)
```
    Gets the length of the value at the position. This method must be implemented if @{code getSlice} is implemented.
  - getByte
```
default byte getByte(int position)
```
    Gets a byte in the value at position.
  - getShort
```
default short getShort(int position)
```
    Gets a little endian short at in the value at position.
  - getInt
```
default int getInt(int position)
```
    Gets a little endian int in the value at position.
  - getLong
```
default long getLong(int position)
```
    Gets a little endian long in the value at position.
  - getLong
```
default long getLong(int position,
                     int offset)
```
    Gets a little endian long at offset in the value at position.
  - getSlice
```
default io.airlift.slice.Slice getSlice(int position,
                                        int offset,
                                        int length)
```
    Gets a slice at offset in the value at position.
  - getBlock
```
default Block getBlock(int position)
```
    Gets a block in the value at position.
    
    Returns:
  - bytesEqual
```
default boolean bytesEqual(int position,
                           int offset,
                           io.airlift.slice.Slice otherSlice,
                           int otherOffset,
                           int length)
```
    Is the byte sequences at offset in the value at position equal to the byte sequence at otherOffset in otherSlice. This method must be implemented if @{code getSlice} is implemented.
  - bytesCompare
```
default int bytesCompare(int position,
                         int offset,
                         int length,
                         io.airlift.slice.Slice otherSlice,
                         int otherOffset,
                         int otherLength)
```
    Compares the byte sequences at offset in the value at position to the byte sequence at otherOffset in otherSlice. This method must be implemented if @{code getSlice} is implemented.
  - writeBytesTo
```
default void writeBytesTo(int position,
                          int offset,
                          int length,
                          BlockBuilder blockBuilder)
```
    Appends the byte sequences at offset in the value at position to blockBuilder. This method must be implemented if @{code getSlice} is implemented.
  - writeBytesTo
```
default void writeBytesTo(int position,
                          int offset,
                          int length,
                          io.airlift.slice.SliceOutput sliceOutput)
```
    Appends the byte sequences at offset in the value at position to sliceOutput. This method must be implemented if @{code getSlice} is implemented.
  - writePositionTo
```
void writePositionTo(int position,
                     BlockBuilder blockBuilder)
```
    Appends the value at position to blockBuilder and close the entry.
  - writePositionTo
```
void writePositionTo(int position,
                     io.airlift.slice.SliceOutput output)
```
    Appends the value at position to output.
  - equals
```
default boolean equals(int position,
                       int offset,
                       Block otherBlock,
                       int otherPosition,
                       int otherOffset,
                       int length)
```
    Is the byte sequences at offset in the value at position equal to the byte sequence at otherOffset in the value at otherPosition in otherBlock. This method must be implemented if @{code getSlice} is implemented.
  - hash
```
default long hash(int position,
                  int offset,
                  int length)
```
    Calculates the hash code the byte sequences at offset in the value at position. This method must be implemented if @{code getSlice} is implemented.
  - compareTo
```
default int compareTo(int leftPosition,
                      int leftOffset,
                      int leftLength,
                      Block rightBlock,
                      int rightPosition,
                      int rightOffset,
                      int rightLength)
```
    Compares the byte sequences at offset in the value at position to the byte sequence at otherOffset in the value at otherPosition in otherBlock. This method must be implemented if @{code getSlice} is implemented.
  - getSingleValueBlock
```
Block getSingleValueBlock(int position)
```
    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.
    
    Throws:
    
    IllegalArgumentException - if this position is not valid
  - getPositionCount
```
int getPositionCount()
```
    Returns the number of positions in this block.
  - getSizeInBytes
```
long getSizeInBytes()
```
    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.
  - getLogicalSizeInBytes
```
default long getLogicalSizeInBytes()
```
    Returns the size of the block contents, regardless of internal representation. The same logical data values should always have the same size, no matter what block type is used or how they are represented within a specific block. This can differ substantially from getSizeInBytes() for certain block types. For RLE, it will be N times larger. For dictionary, it will be larger based on how many times dictionary entries are reused.
  - getRegionSizeInBytes
```
long getRegionSizeInBytes(int position,
                          int length)
```
    Returns the size of block.getRegion(position, length). The method can be expensive. Do not use it outside an implementation of Block.
  - getRegionLogicalSizeInBytes
```
default long getRegionLogicalSizeInBytes(int position,
                                         int length)
```
    Returns the size of block.getRegion(position, length). The method can be expensive. Do not use it outside an implementation of Block.
  - getApproximateRegionLogicalSizeInBytes
```
default long getApproximateRegionLogicalSizeInBytes(int position,
                                                    int length)
```
    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.
  - fixedSizeInBytesPerPosition
```
OptionalInt fixedSizeInBytesPerPosition()
```
    Returns the number of bytes (in terms of 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 getPositionsSizeInBytes(boolean[], int) which would require computing the specific positions selected
    
    Returns:
    
    The size in bytes, per position, if this block type does not require specific position information to compute its size
  - getPositionsSizeInBytes
```
long getPositionsSizeInBytes(boolean[] positions,
                             int usedPositionCount)
```
    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.
  - getRetainedSizeInBytes
```
long getRetainedSizeInBytes()
```
    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.
  - getEstimatedDataSizeForStats
```
long getEstimatedDataSizeForStats(int position)
```
    Returns the estimated in memory data size for stats of position. Do not use it for other purpose.
  - retainedBytesForEachPart
```
void retainedBytesForEachPart(ObjLongConsumer<Object> consumer)
```
    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
  - getEncodingName
```
String getEncodingName()
```
    Get the encoding for this block.
  - getPositions
```
default Block getPositions(int[] positions,
                           int offset,
                           int length)
```
    Create a new block from the current block by keeping the same elements only with respect to positions that starts at offset and has length of length. May return a view over the data in this block or may return a copy
  - copyPositions
```
Block copyPositions(int[] positions,
                    int offset,
                    int length)
```
    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.
  - getRegion
```
Block getRegion(int positionOffset,
                int length)
```
    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.
  - copyRegion
```
Block copyRegion(int position,
                 int length)
```
    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.
  - mayHaveNull
```
default 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.
  - isNull
```
boolean isNull(int position)
```
    Is the specified position null?
    
    Throws:
    
    IllegalArgumentException - if this position is not valid
  - getLoadedBlock
```
default Block getLoadedBlock()
```
    Returns a block that assures all data is in memory. May return the same block if all block data is already in memory.
    This allows streaming data sources to skip sections that are not accessed in a query.
  - appendNull
```
Block appendNull()
```
    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.

Interface Block

Method Summary

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

Method Detail

getSliceLength

getByte

getShort

getInt

getLong

getLong

getSlice

getBlock

bytesEqual

bytesCompare

writeBytesTo

writeBytesTo

writePositionTo

writePositionTo

equals

hash

compareTo

getSingleValueBlock

getPositionCount

getSizeInBytes

getLogicalSizeInBytes

getRegionSizeInBytes

getRegionLogicalSizeInBytes

getApproximateRegionLogicalSizeInBytes

fixedSizeInBytesPerPosition

getPositionsSizeInBytes

getRetainedSizeInBytes

getEstimatedDataSizeForStats

retainedBytesForEachPart

getEncodingName

getPositions

copyPositions

getRegion

copyRegion

mayHaveNull

isNull

getLoadedBlock

appendNull