Package com.qfs.dic

Interface ICharSequenceDictionary<C extends CharSequence>

All Superinterfaces:

ICompressible, IDictionary<C>, IMemoryMonitored, Serializable

All Known Implementing Classes:

StringDictionary

public interface ICharSequenceDictionary<C extends CharSequence>
extends IDictionary<C>

Interface of a dictionary that stores some type of character sequence.

Author:

ActiveViam

Field Summary

Fields inherited from interface com.qfs.dic.IDictionary

DEFAULT_INITIAL_CAPACITY, ID_GENERATOR

Method Summary

Modifier and Type	Method	Description
default void	copyInto(int position, IWritableCell cell)	Copies the de-dictionarized value at a given position into the provided cell.
String	readString(int position)	Reads characters of the sequence stored at that position and returns them in an String.
int	transfer(int position, char[] receiver)	Transfers the sequence at that position into a character array.

Methods inherited from interface com.qfs.memory.ICompressible

compress, compress

Methods inherited from interface com.qfs.dic.IDictionary

getDictionaryId, getDoublePosition, getFirstElements, getFloatPosition, getIntPosition, getLongPosition, getOrder, getPosition, getSize, getType, isNullable, read, readDouble, readFloat, readInt, readLong, size, supportConcurrentReads

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

getMemoryStatistic

Method Detail

readString

String readString(int position)

Reads characters of the sequence stored at that position and returns them in an String. Calling this method allocates some memory for the array and for the String.

Parameters:

position - the position

Returns:

characters of the sequence in a String

transfer

int transfer(int position,
             char[] receiver)

Transfers the sequence at that position into a character array. The array must be large enough to receive the characters.

Parameters:

receiver - buffer filled with the sequence read at the position

Returns:

number of characters actually transferred (that is the max of the length of the sequence at that position, and the receiver array length)

copyInto

default void copyInto(int position,
                      IWritableCell cell)

Description copied from interface: IDictionary

Copies the de-dictionarized value at a given position into the provided cell.

Specified by:

copyInto in interface IDictionary<C extends CharSequence>

Parameters:

position - dictionarized value to read

cell - cell filled with the corresponding value