AbstractMapBlock (presto-spi 0.220 API)

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

All Implemented Interfaces:

Block

Direct Known Subclasses:

MapBlock, MapBlockBuilder
```
public abstract class AbstractMapBlock
extends Object
implements Block
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractMapBlock.HashTables

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractMapBlock.HashTables`

Field Summary

Fields
Modifier and Type	Field and Description
`protected MethodHandle`	`keyBlockHashCode`
`protected MethodHandle`	`keyBlockNativeEquals`
`protected MethodHandle`	`keyNativeHashCode`
`protected Type`	`keyType`

Constructor Summary

Constructors
Constructor and Description
`AbstractMapBlock(Type keyType, MethodHandle keyNativeHashCode, MethodHandle keyBlockNativeEquals, MethodHandle keyBlockHashCode)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`protected abstract void`	`ensureHashTableLoaded()`
`String`	`getEncodingName()` Get the encoding for this block.
`long`	`getEstimatedDataSizeForStats(int position)` Returns the estimated in memory data size for stats of position.
`protected abstract AbstractMapBlock.HashTables`	`getHashTables()`
`protected abstract boolean[]`	`getMapIsNull()`
`<T> T`	`getObject(int position, Class<T> clazz)` Gets an object in the value at `position`.
`protected abstract int`	`getOffsetBase()` offset is entry-based, not position-based.
`protected abstract int[]`	`getOffsets()` offset is entry-based, not position-based.
`long`	`getPositionsSizeInBytes(boolean[] positions)` Returns the size of of all positions marked true in the positions array.
`protected abstract Block`	`getRawKeyBlock()`
`protected abstract Block`	`getRawValueBlock()`
`Block`	`getRegion(int position, 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)`.
`Block`	`getSingleValueBlock(int position)` Gets the value at the specified position as a single element block.
`boolean`	`isHashTablesPresent()`
`boolean`	`isNull(int position)` Is the specified position null?
`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.

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.spi.block.Block
bytesCompare, bytesEqual, compareTo, equals, getByte, getInt, getLoadedBlock, getLogicalSizeInBytes, getLong, getLong, getPositionCount, getPositions, getRetainedSizeInBytes, getShort, getSizeInBytes, getSlice, getSliceLength, hash, retainedBytesForEachPart, writeBytesTo

- Field Detail
  - keyType
```
protected final Type keyType
```
  - keyNativeHashCode
```
protected final MethodHandle keyNativeHashCode
```
  - keyBlockNativeEquals
```
protected final MethodHandle keyBlockNativeEquals
```
  - keyBlockHashCode
```
protected final MethodHandle keyBlockHashCode
```
- Constructor Detail
  - AbstractMapBlock
```
public AbstractMapBlock(Type keyType,
                        MethodHandle keyNativeHashCode,
                        MethodHandle keyBlockNativeEquals,
                        MethodHandle keyBlockHashCode)
```
- Method Detail
  - getRawKeyBlock
```
protected abstract Block getRawKeyBlock()
```
  - getRawValueBlock
```
protected abstract Block getRawValueBlock()
```
  - getHashTables
```
protected abstract AbstractMapBlock.HashTables getHashTables()
```
  - getOffsets
```
protected abstract int[] getOffsets()
```
    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).
  - getOffsetBase
```
protected abstract int getOffsetBase()
```
    offset is entry-based, not position-based. (see getOffsets)
  - getMapIsNull
```
@Nullable
protected abstract boolean[] getMapIsNull()
```
  - ensureHashTableLoaded
```
protected abstract void ensureHashTableLoaded()
```
  - getEncodingName
```
public String getEncodingName()
```
    Description copied from interface: Block
    
    Get the encoding for this block.
    
    Specified by:
    
    getEncodingName 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 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
  - 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 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
  - 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
  - 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
  - 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
  - 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
  - isNull
```
public boolean isNull(int position)
```
    Description copied from interface: Block
    
    Is the specified position null?
    
    Specified by:
    
    isNull in interface Block
  - isHashTablesPresent
```
public boolean isHashTablesPresent()
```

Class AbstractMapBlock

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

keyType

keyNativeHashCode

keyBlockNativeEquals

keyBlockHashCode

Constructor Detail

AbstractMapBlock

Method Detail

getRawKeyBlock

getRawValueBlock

getHashTables

getOffsets

getOffsetBase

getMapIsNull

ensureHashTableLoaded

getEncodingName

copyPositions

getRegion

getRegionSizeInBytes

getPositionsSizeInBytes

copyRegion

getObject

writePositionTo

getSingleValueBlock

getEstimatedDataSizeForStats

mayHaveNull

isNull

isHashTablesPresent