org.apache.ignite.internal.cache.query.index.sorted.inline

Interface InlineIndexKeyType

All Known Implementing Classes:

BooleanInlineIndexKeyType, ByteInlineIndexKeyType, BytesInlineIndexKeyType, DateInlineIndexKeyType, DoubleInlineIndexKeyType, FloatInlineIndexKeyType, IntegerInlineIndexKeyType, LongInlineIndexKeyType, NullableInlineIndexKeyType, ObjectByteArrayInlineIndexKeyType, ObjectHashInlineIndexKeyType, ShortInlineIndexKeyType, SignedBytesInlineIndexKeyType, StringInlineIndexKeyType, StringNoCompareInlineIndexKeyType, TimeInlineIndexKeyType, TimestampInlineIndexKeyType, UuidInlineIndexKeyType

public interface InlineIndexKeyType

Basic interface for inlined index columns. It's not a generic to provide opportunity compare different types.

Method Summary

Modifier and Type	Method and Description
int	compare(long pageAddr, int off, int maxSize, IndexKey v) Compares inlined and given value.
@Nullable IndexKey	get(long pageAddr, int off, int maxSize)
int	inlineSize() Returns size of inlined key.
int	inlineSize(IndexKey key) Returns inline size for specified key.
int	inlineSize(long pageAddr, int off) Actual size of inline value.
int	put(long pageAddr, int off, IndexKey key, int maxSize) Puts given value into inline index tree.
int	type() Returns type of inlined column.

Method Detail

type

int type()

Returns type of inlined column.

Returns:

Integer code of the column's value type.

inlineSize

int inlineSize()

Returns size of inlined key. Note: system fields (e.g. type, length) are taken into account as well.

inlineSize

int inlineSize(IndexKey key)

Returns inline size for specified key. Note: system fields (e.g. type, length) are taken into account as well.

inlineSize

int inlineSize(long pageAddr,
               int off)

Actual size of inline value. It returns keySize() + 1 for values with fixed size and amount of written bytes for values with variable length. Used for dynamic offset calculation by page for variable length values.

Parameters:

pageAddr - Page address.

off - Offset.

Returns:

Returns actual size of inlined value.

put

int put(long pageAddr,
        int off,
        IndexKey key,
        int maxSize)

Puts given value into inline index tree.

Parameters:

pageAddr - Page address.

off - Offset.

key - Index key.

maxSize - Max size.

Returns:

Amount of bytes actually stored.

get

@Nullable
@Nullable IndexKey get(long pageAddr,
                                 int off,
                                 int maxSize)

compare

int compare(long pageAddr,
            int off,
            int maxSize,
            IndexKey v)

Compares inlined and given value.

Parameters:

pageAddr - Page address.

off - Offset.

maxSize - Max size.

v - Value that should be compare.

Returns:

-1, 0 or 1 if inlined value less, equal or greater than given respectively, or -2 if inlined part is not enough to compare.