RunLengthEncodedBlock (presto-spi 0.220 API)

java.lang.Object
- com.facebook.presto.spi.block.RunLengthEncodedBlock

All Implemented Interfaces:: Block

public class RunLengthEncodedBlock
extends Object
implements Block

Constructor Summary

Constructors
Constructor and Description

RunLengthEncodedBlock(Block value, int positionCount)

Constructors
Constructor and Description
`RunLengthEncodedBlock(Block value, int positionCount)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`.
`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`.
`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 positionOffset, int length)` Returns a block starting at the specified position and extends for the specified length.
`static Block`	`create(Type type, Object value, int positionCount)`
`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`.
`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.
`int`	`getInt(int position)` Gets a little endian int in the value at `position`.
`Block`	`getLoadedBlock()` Returns a block that assures all data is in memory.
`long`	`getLogicalSizeInBytes()` Returns the size of the block contents, regardless of internal representation.
`long`	`getLong(int position)` Gets a little endian long in the value at `position`.
`long`	`getLong(int position, int offset)` Gets a little endian long at `offset` in the value at `position`.
`<T> T`	`getObject(int position, Class<T> clazz)` Gets an object in the value at `position`.
`int`	`getPositionCount()` Returns the number of positions in this block.
`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)` Returns the size of 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.
`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.
`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.
`io.airlift.slice.Slice`	`getSlice(int position, int offset, int length)` Gets a slice at `offset` in the value at `position`.
`int`	`getSliceLength(int position)` Gets the length of the value at the `position`.
`Block`	`getValue()`
`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?
`void`	`retainedBytesForEachPart(BiConsumer<Object,Long> consumer)` `consumer` visits each of the internal data container and accepts the size for it.
`String`	`toString()`
`void`	`writeBytesTo(int position, int offset, int length, BlockBuilder blockBuilder)` Appends the byte sequences at `offset` in the value at `position` to `blockBuilder`.
`void`	`writePositionTo(int position, BlockBuilder blockBuilder)` Appends the value at `position` to `blockBuilder` and close the entry.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.presto.spi.block.Block
mayHaveNull

- Constructor Detail
  - RunLengthEncodedBlock
```
public RunLengthEncodedBlock(Block value,
                             int positionCount)
```
- Method Detail
  - create
```
public static Block create(Type type,
                           Object value,
                           int positionCount)
```
  - getValue
```
public Block getValue()
```
  - 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
  - getLogicalSizeInBytes
```
public long getLogicalSizeInBytes()
```
    Description copied from interface: Block
    
    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 Block.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.
    
    Specified by:
    
    getLogicalSizeInBytes 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
  - 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
  - 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
  - getEncodingName
```
public String getEncodingName()
```
    Description copied from interface: Block
    
    Get the encoding for this block.
    
    Specified by:
    
    getEncodingName in interface Block
  - getPositions
```
public Block getPositions(int[] positions,
                          int offset,
                          int length)
```
    Description copied from interface: Block
    
    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
    
    Specified by:
    
    getPositions 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getByte
```
public byte getByte(int position)
```
    Description copied from interface: Block
    
    Gets a byte in the value at position.
    
    Specified by:
    
    getByte in interface Block
  - getShort
```
public short getShort(int position)
```
    Description copied from interface: Block
    
    Gets a little endian short at in the value at position.
    
    Specified by:
    
    getShort in interface Block
  - getInt
```
public int getInt(int position)
```
    Description copied from interface: Block
    
    Gets a little endian int in the value at position.
    
    Specified by:
    
    getInt in interface Block
  - getLong
```
public long getLong(int position)
```
    Description copied from interface: Block
    
    Gets a little endian long in the value at position.
    
    Specified by:
    
    getLong in interface Block
  - getLong
```
public long getLong(int position,
                    int offset)
```
    Description copied from interface: Block
    
    Gets a little endian long at offset in the value at position.
    
    Specified by:
    
    getLong in interface Block
  - getSlice
```
public io.airlift.slice.Slice getSlice(int position,
                                       int offset,
                                       int length)
```
    Description copied from interface: Block
    
    Gets a slice at offset in the value at position.
    
    Specified by:
    
    getSlice in interface Block
  - getObject
```
public <T> T getObject(int position,
                       Class<T> clazz)
```
    Description copied from interface: Block
    
    Gets an object in the value at position.
    
    Specified by:
    
    getObject in interface Block
  - bytesEqual
```
public boolean bytesEqual(int position,
                          int offset,
                          io.airlift.slice.Slice otherSlice,
                          int otherOffset,
                          int length)
```
    Description copied from interface: Block
    
    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.
    
    Specified by:
    
    bytesEqual in interface Block
  - bytesCompare
```
public int bytesCompare(int position,
                        int offset,
                        int length,
                        io.airlift.slice.Slice otherSlice,
                        int otherOffset,
                        int otherLength)
```
    Description copied from interface: Block
    
    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.
    
    Specified by:
    
    bytesCompare in interface Block
  - writeBytesTo
```
public void writeBytesTo(int position,
                         int offset,
                         int length,
                         BlockBuilder blockBuilder)
```
    Description copied from interface: Block
    
    Appends the byte sequences at offset in the value at position to blockBuilder. This method must be implemented if @{code getSlice} is implemented.
    
    Specified by:
    
    writeBytesTo in interface Block
  - 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
  - equals
```
public boolean equals(int position,
                      int offset,
                      Block otherBlock,
                      int otherPosition,
                      int otherOffset,
                      int length)
```
    Description copied from interface: Block
    
    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.
    
    Specified by:
    
    equals in interface Block
  - hash
```
public long hash(int position,
                 int offset,
                 int length)
```
    Description copied from interface: Block
    
    Calculates the hash code the byte sequences at offset in the value at position. This method must be implemented if @{code getSlice} is implemented.
    
    Specified by:
    
    hash in interface Block
  - compareTo
```
public int compareTo(int leftPosition,
                     int leftOffset,
                     int leftLength,
                     Block rightBlock,
                     int rightPosition,
                     int rightOffset,
                     int rightLength)
```
    Description copied from interface: Block
    
    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.
    
    Specified by:
    
    compareTo 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 method must copy the data into a new 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
  - isNull
```
public boolean isNull(int position)
```
    Description copied from interface: Block
    
    Is the specified position null?
    
    Specified by:
    
    isNull in interface Block
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLoadedBlock
```
public Block getLoadedBlock()
```
    Description copied from interface: Block
    
    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.
    
    Specified by:
    
    getLoadedBlock in interface Block

Class RunLengthEncodedBlock

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

RunLengthEncodedBlock

Method Detail

create

getValue

getPositionCount

getSizeInBytes

getLogicalSizeInBytes

getRetainedSizeInBytes

getEstimatedDataSizeForStats

retainedBytesForEachPart

getEncodingName

getPositions

copyPositions

getRegion

getRegionSizeInBytes

getPositionsSizeInBytes

copyRegion

getSliceLength

getByte

getShort

getInt

getLong

getLong

getSlice

getObject

bytesEqual

bytesCompare

writeBytesTo

writePositionTo

equals

hash

compareTo

getSingleValueBlock

isNull

toString

getLoadedBlock