Package com.qfs.chunk

Interface IChunkInteger

All Superinterfaces:

IArray, IArrayReader, IArrayWriter, IChunk<Integer>, IMemoryMonitored, IWritableArray

All Known Subinterfaces:

IChunkPositiveInteger, IChunkPrimitiveInteger, IConcurrentChunkInteger

All Known Implementing Classes:

AChunkPositiveInteger, AChunkPrimitiveInteger, ADirectChunkPrimitiveInteger, ArrayChunkBits, ArrayChunkBytes, ArrayChunkHexa, ArrayChunkInteger, ArrayChunkIntegerNullable, ArrayChunkPositiveInteger, ArrayChunkQuad, ArrayChunkShorts, ArrayChunkTriBytes, BufferChunkPositiveInteger, BufferChunkPrimitiveBits, BufferChunkPrimitiveBytes, BufferChunkPrimitiveHexa, BufferChunkPrimitiveInts, BufferChunkPrimitiveIntsNullable, BufferChunkPrimitiveQuad, BufferChunkPrimitiveShorts, BufferChunkPrimitiveTriBytes, ChunkOffsetInteger, ChunkSingleInteger, DirectChunkBits, DirectChunkBytes, DirectChunkHexa, DirectChunkInteger, DirectChunkIntegerNullable, DirectChunkPositiveInteger, DirectChunkQuad, DirectChunkShorts, DirectChunkTriBytes, FrequentIntegerChunk, FrequentNullIntegerChunk, NullableFrequentIntegerChunk

public interface IChunkInteger
extends IChunk<Integer>

Specialized chunk that stores integer primitive data.

Specialized primitive read operations access the physical storage directly and ignore null checks, so when dealing with implementations that support null values, the IArrayReader.isNull(int) method must be called before reading the value.

Implementations must override the readInt(int) and writeInt(int, int) methods that are used in all default implementations within this interface.

Author:

ActiveViam

Field Summary

Fields inherited from interface com.qfs.chunk.IChunk

NO_SIZE_LIMIT

Method Summary

Modifier and Type	Method	Description
static int	computeOrder(int bitsUsed)	Computes the order of the chunks that can hold the data.
default void	copyInto(int position, IWritableCell cell)	Copies the value at a given position in this chunk into the provided cell.
default IFrequentValueChunk<Integer>	createFrequentValueChunk(int chunkSize, Integer frequentValue, IChunk<Integer> underlyingChunk, IRowMapping mapping, boolean hasNullValues)	Creates a compressed version of this chunk using frequency compression.
boolean	equals(int position, int value)	Tests if the record stored at that position is equal to a value.
default void	fill(int value)	Fills all slots in the chunk with the same value.
default int	getBindingType()	Gets the type for binding transfers of this chunk.
default int	getOrder()	Gets this chunk order, i.e.
default boolean	isPrimitive()	Returns whether this chunk contains primitive data, as per Types.isPrimitive(int).
Integer	read(int position)	Returns the data stored at that position in the chunk.
double	readDouble(int position)	Reads a double primitive value from the array.
float	readFloat(int position)	Reads a float primitive value from the array.
int	readInt(int position)	Reads an int primitive value from the array.
long	readLong(int position)	Reads a long primitive value from the array.
default void	transfer(IWritableTable destination, int destinationColumn, int[] rowsMapping, int numRows)	Transfers a given number of rows from this chunk to target rows in the given column of the destination table.
void	write(int position, Object value)	Writes a piece of data at a position in the array.
default void	writeFromCell(int position, IReadableCell cell)	Writes the content of the cell into the chunk at the given position.
void	writeInt(int position, int value)	Writes an int primitive value in the array.

Methods inherited from interface com.qfs.chunk.IArrayReader

isNull, readBoolean, readVector

Methods inherited from interface com.qfs.chunk.IArrayWriter

addDouble, addFloat, addInt, addLong, writeBoolean, writeDouble, writeFloat, writeLong

Methods inherited from interface com.qfs.chunk.IChunk

capacity, compress, createArrayCursor, destroy, findRowsEqualTo, findRowsEqualTo, findRowsEqualTo, findRowsInSet, findRowsInSet, findRowsInSet, findRowsInTransactionEqualTo, findRowsInTransactionEqualTo, findRowsInTransactionEqualTo, findRowsInTransactionInSet, findRowsInTransactionInSet, findRowsInTransactionInSet, freeRow, getChunkCreatorForSparse, getChunkId, getChunkType, getPhysicalSize, isDead, localRow, replaceBy, reset, sparseChunkCompression

Methods inherited from interface com.qfs.monitoring.memory.IMemoryMonitored

getMemoryStatistic

Method Details

isPrimitive

default boolean isPrimitive()

Description copied from interface: IChunk

Returns whether this chunk contains primitive data, as per Types.isPrimitive(int).

Specified by:

isPrimitive in interface IChunk<Integer>

Returns:

true if this chunk contains primitive data, as per Types.isPrimitive(int), false otherwise

getBindingType

default int getBindingType()

Description copied from interface: IChunk

Gets the type for binding transfers of this chunk.

Specified by:

getBindingType in interface IChunk<Integer>

Returns:

the physical type like Types.PHYSICAL_INT, etc

copyInto

default void copyInto(int position,
 IWritableCell cell)

Description copied from interface: IChunk

Copies the value at a given position in this chunk into the provided cell.

Specified by:

copyInto in interface IChunk<Integer>

Parameters:

position - row of the chunk to read

writeFromCell

default void writeFromCell(int position,
 IReadableCell cell)

Description copied from interface: IChunk

Writes the content of the cell into the chunk at the given position.

It is up to chunks to use the appropriate read method to avoid boxing as much as possible.

Specified by:

writeFromCell in interface IChunk<Integer>

fill

default void fill(int value)

Fills all slots in the chunk with the same value.

Parameters:

value - the value to fill the chunk with

equals

boolean equals(int position,
 int value)

Tests if the record stored at that position is equal to a value.

Parameters:

position - the position to read

value - the value to compare

Returns:

true if the read value is the same as the given value, false otherwise

getOrder

default int getOrder()

Gets this chunk order, i.e. the number of bits used to represent this chunk data.

If the actual data can be represented with less bits, the compression will create a chunk with a lower order.

Returns:

the current chunk order

computeOrder

static int computeOrder(int bitsUsed)

Computes the order of the chunks that can hold the data.

Parameters:

bitsUsed - the number of bits used in the chunk

Returns:

the order of the chunks that can hold the data

read

Integer read(int position)

Description copied from interface: IChunk

Returns the data stored at that position in the chunk.

Specified by:

read in interface IArrayReader

Specified by:

read in interface IChunk<Integer>

Parameters:

position - the position in the chunk at which to read

Returns:

the data stored at that position in the chunk

readInt

int readInt(int position)

Description copied from interface: IArrayReader

Reads an int primitive value from the array.

An exception is thrown if the value is not of the right type.

Specified by:

readInt in interface IArrayReader

Parameters:

position - 0-based index in an array

Returns:

int value

readLong

long readLong(int position)

Description copied from interface: IArrayReader

Reads a long primitive value from the array.

An exception is thrown if the value is not of the right type.

Specified by:

readLong in interface IArrayReader

Parameters:

position - 0-based index in an array

Returns:

long value

readFloat

float readFloat(int position)

Description copied from interface: IArrayReader

Reads a float primitive value from the array.

An exception is thrown if the value is not of the right type.

Specified by:

readFloat in interface IArrayReader

Parameters:

position - 0-based index in an array

Returns:

float value

readDouble

double readDouble(int position)

Description copied from interface: IArrayReader

Reads a double primitive value from the array.

An exception is thrown if the value is not of the right type.

Specified by:

readDouble in interface IArrayReader

Parameters:

position - 0-based index in an array

Returns:

double value

write

void write(int position,
 Object value)

Description copied from interface: IArrayWriter

Writes a piece of data at a position in the array.

For better performance, use the primitive type operations.

Specified by:

write in interface IArrayWriter

Parameters:

position - 0-based index in the array

value - the value to write

writeInt

void writeInt(int position,
 int value)

Description copied from interface: IArrayWriter

Writes an int primitive value in the array.

Specified by:

writeInt in interface IArrayWriter

Parameters:

position - 0-based index in the array

value - the value to write

transfer

default void transfer(IWritableTable destination,
 int destinationColumn,
 int[] rowsMapping,
 int numRows)

Description copied from interface: IChunk

Transfers a given number of rows from this chunk to target rows in the given column of the destination table.

The mapping from the source rows to the target rows is described with an array of 2*n slots. Each even slot contains the index of the row to be copied from the source chunk and the following odd slot contains the index of the row into which the source data will be transferred.

Specified by:

transfer in interface IChunk<Integer>

Parameters:

destination - the destination table

destinationColumn - the column to transfer the data to in the destination table

rowsMapping - the mapping from source rows to target rows, as explained above

numRows - the number of rows to transfer

createFrequentValueChunk

default IFrequentValueChunk<Integer> createFrequentValueChunk(int chunkSize,
 Integer frequentValue,
 IChunk<Integer> underlyingChunk,
 IRowMapping mapping,
 boolean hasNullValues)

Description copied from interface: IChunk

Creates a compressed version of this chunk using frequency compression.

Specified by:

createFrequentValueChunk in interface IChunk<Integer>

Parameters:

chunkSize - visible size of the compressed chunk

underlyingChunk - underlying chunk containing values different from the frequent value

mapping - mapping liking visible rows to each non-frequent value

hasNullValues - flag indicating if the underlying chunk contains null values.

See Also:

• IFrequentValueChunk