com.facebook.presto.spi.block

Interface Block

All Known Subinterfaces:

BlockBuilder

All Known Implementing Classes:

AbstractArrayBlock, AbstractArrayElementBlock, AbstractFixedWidthBlock, AbstractInterleavedBlock, AbstractVariableWidthBlock, ArrayBlock, ArrayBlockBuilder, ArrayElementBlockWriter, DictionaryBlock, FixedWidthBlock, FixedWidthBlockBuilder, InterleavedBlock, InterleavedBlockBuilder, LazyArrayBlock, LazyBlock, LazyFixedWidthBlock, LazySliceArrayBlock, RunLengthEncodedBlock, SliceArrayBlock, VariableWidthBlock, VariableWidthBlockBuilder

public interface Block

Method Summary

Modifier and Type	Method and Description
void	assureLoaded() Assures that all data for the block is in memory.
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(List<Integer> positions) 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.
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, int offset) Gets a byte at offset in the value at position.
double	getDouble(int position, int offset) Gets a little endian double at offset in the value at position.
BlockEncoding	getEncoding() Get the encoding for this block.
float	getFloat(int position, int offset) Gets a little endian float at offset in the value at position.
int	getInt(int position, int offset) Gets a little endian int at offset in the value at position.
int	getLength(int position) Gets the length of the value at the position.
long	getLong(int position, int offset) Gets a little endian long at offset in the value at position.
default <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	getRegion(int positionOffset, int length) Returns a block starting at the specified position and extends for the specified length.
int	getRetainedSizeInBytes() Returns the retained size of this block in memory.
short	getShort(int position, int offset) Gets a little endian short at offset in the value at position.
Block	getSingleValueBlock(int position) Gets the value at the specified position as a single element block.
int	getSizeInBytes() Returns the logical size of this block in memory.
io.airlift.slice.Slice	getSlice(int position, int offset, int length) Gets a slice at offset in the value at position.
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	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.

Method Detail

getLength

int getLength(int position)

Gets the length of the value at the position.

getByte

byte getByte(int position,
             int offset)

Gets a byte at offset in the value at position.

getShort

short getShort(int position,
               int offset)

Gets a little endian short at offset in the value at position.

getInt

int getInt(int position,
           int offset)

Gets a little endian int at offset in the value at position.

getLong

long getLong(int position,
             int offset)

Gets a little endian long at offset in the value at position.

getFloat

float getFloat(int position,
               int offset)

Gets a little endian float at offset in the value at position.

getDouble

double getDouble(int position,
                 int offset)

Gets a little endian double at offset in the value at position.

getSlice

io.airlift.slice.Slice getSlice(int position,
                                int offset,
                                int length)

Gets a slice at offset in the value at position.

getObject

default <T> T getObject(int position,
                        Class<T> clazz)

Gets an object in the value at position.

bytesEqual

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.

bytesCompare

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.

writeBytesTo

void writeBytesTo(int position,
                  int offset,
                  int length,
                  BlockBuilder blockBuilder)

Appends the byte sequences at offset in the value at position to blockBuilder.

writePositionTo

void writePositionTo(int position,
                     BlockBuilder blockBuilder)

Appends the value at position to blockBuilder.

equals

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.

hash

long hash(int position,
          int offset,
          int length)

Calculates the hash code the byte sequences at offset in the value at position.

compareTo

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.

getSingleValueBlock

Block getSingleValueBlock(int position)

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.

Throws:

IllegalArgumentException - if this position is not valid

getPositionCount

int getPositionCount()

Returns the number of positions in this block.

getSizeInBytes

int getSizeInBytes()

Returns the logical size of this block in memory.

getRetainedSizeInBytes

int getRetainedSizeInBytes()

Returns the retained size of this block in memory.

getEncoding

BlockEncoding getEncoding()

Get the encoding for this block.

copyPositions

Block copyPositions(List<Integer> positions)

Returns a block containing the specified positions. 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.

isNull

boolean isNull(int position)

Is the specified position null?

Throws:

IllegalArgumentException - if this position is not valid

assureLoaded

void assureLoaded()

Assures that all data for the block is in memory.

This allows streaming data sources to skip sections that are not accessed in a query.