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

Class NullableInlineIndexKeyType<T extends IndexKey>

java.lang.Object

org.apache.ignite.internal.cache.query.index.sorted.inline.types.NullableInlineIndexKeyType<T>

All Implemented Interfaces:

InlineIndexKeyType

Direct Known Subclasses:

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

public abstract class NullableInlineIndexKeyType<T extends IndexKey>
extends Object
implements InlineIndexKeyType

Abstract inline key. Store base logic for work with inlined keys. Handle NULL values.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANT_BE_COMPARE Value for comparison meaning 'Not enough information to compare'.
static int	COMPARE_UNSUPPORTED Value for comparison meaning 'Compare not supported for given value'.
protected short	keySize Actual size of a key without type field.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NullableInlineIndexKeyType(int type, short keySize)

Method Summary

Modifier and Type	Method and Description
int	compare(long pageAddr, int off, int maxSize, IndexKey key) Compares inlined and given value.
abstract int	compare0(long pageAddr, int off, T v) Compares inlined and given value.
IndexKey	get(long pageAddr, int off, int maxSize) Restores value from inline, if possible.
protected abstract T	get0(long pageAddr, int off) Restores value from inline.
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.
protected abstract int	inlineSize0(T key) Return inlined size for specified key.
int	put(long pageAddr, int off, IndexKey key, int maxSize) Puts given value into inline index tree.
protected abstract int	put0(long pageAddr, int off, T val, int maxSize) Puts given value into inline index tree.
protected byte[]	readBytes(long pageAddr, int off) Read variable length bytearray
int	type() Returns type of inlined column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CANT_BE_COMPARE

public static final int CANT_BE_COMPARE

Value for comparison meaning 'Not enough information to compare'.

See Also:

Constant Field Values

COMPARE_UNSUPPORTED

public static final int COMPARE_UNSUPPORTED

Value for comparison meaning 'Compare not supported for given value'.

See Also:

Constant Field Values

keySize

protected final short keySize

Actual size of a key without type field.

Constructor Detail

NullableInlineIndexKeyType

protected NullableInlineIndexKeyType(int type,
                                     short keySize)

Parameters:

type - Index key type.

keySize - Size of value stored in the key.

Method Detail

type

public int type()

Returns type of inlined column.

Specified by:

type in interface InlineIndexKeyType

Returns:

Integer code of the column's value type.

inlineSize

public 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.

Specified by:

inlineSize in interface InlineIndexKeyType

Parameters:

pageAddr - Page address.

off - Offset.

Returns:

Returns actual size of inlined value.

inlineSize

public int inlineSize()

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

Specified by:

inlineSize in interface InlineIndexKeyType

inlineSize

public int inlineSize(IndexKey key)

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

Specified by:

inlineSize in interface InlineIndexKeyType

get

public IndexKey get(long pageAddr,
                    int off,
                    int maxSize)

Restores value from inline, if possible.

Specified by:

get in interface InlineIndexKeyType

Parameters:

pageAddr - Address of the page.

off - Offset on the page.

maxSize - Max size to read.

Returns:

Restored value or null if value can't be restored.

put

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

Puts given value into inline index tree.

Specified by:

put in interface InlineIndexKeyType

Parameters:

pageAddr - Page address.

off - Offset.

key - Index key.

maxSize - Max size.

Returns:

Amount of bytes actually stored.

put0

protected abstract int put0(long pageAddr,
                            int off,
                            T val,
                            int maxSize)

Puts given value into inline index tree.

Parameters:

pageAddr - Page address.

off - Offset.

val - Value.

maxSize - Max size.

Returns:

Amount of bytes actually stored.

get0

@Nullable
protected abstract T get0(long pageAddr,
                                    int off)

Restores value from inline.

Parameters:

pageAddr - Page address.

off - Offset.

Returns:

Inline value or null if value can't be restored.

readBytes

protected byte[] readBytes(long pageAddr,
                           int off)

Read variable length bytearray

compare

public int compare(long pageAddr,
                   int off,
                   int maxSize,
                   IndexKey key)

Compares inlined and given value.

Specified by:

compare in interface InlineIndexKeyType

Parameters:

pageAddr - Page address.

off - Offset.

maxSize - Max size.

key - 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.

compare0

public abstract int compare0(long pageAddr,
                             int off,
                             T v)

Compares inlined and given value.

Parameters:

pageAddr - Page address.

off - Offset.

v - Value that should be compare.

Returns:

-1, 0 or 1 if inlined value less, equal or greater than given respectively, CANT_BE_COMPARE if inlined part is not enough to compare, or COMPARE_UNSUPPORTED if given value can't be compared with inlined part at all.

inlineSize0

protected abstract int inlineSize0(T key)

Return inlined size for specified key.