org.apache.ignite.internal.processors.query.h2.database.inlinecolumn

Class AbstractInlineIndexColumn

java.lang.Object

org.apache.ignite.internal.processors.query.h2.database.inlinecolumn.AbstractInlineIndexColumn

All Implemented Interfaces:

InlineIndexColumn

Direct Known Subclasses:

BooleanInlineIndexColumn, ByteInlineIndexColumn, BytesInlineIndexColumn, DateInlineIndexColumn, DecimalInlineIndexColumn, DoubleInlineIndexColumn, FloatInlineIndexColumn, IntegerInlineIndexColumn, LongInlineIndexColumn, ObjectHashInlineIndexColumn, ShortInlineIndexColumn, StringInlineIndexColumn, TimeInlineIndexColumn, TimestampInlineIndexColumn, UuidInlineIndexColumn

public abstract class AbstractInlineIndexColumn
extends Object
implements InlineIndexColumn

Abstract inline column. Implements basic methods of interface InlineIndexColumn.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInlineIndexColumn(org.gridgain.internal.h2.table.Column col, int type, short size)

Method Summary

Modifier and Type	Method and Description
int	columnIndex() Returns index of the inlined column.
String	columnName() Returns name of the inlined column.
String	columnSql() Returns sql representation of the inlined column.
int	compare(long pageAddr, int off, int maxSize, org.gridgain.internal.h2.value.Value v, Comparator<org.gridgain.internal.h2.value.Value> comp) Compares inlined and given value.
protected abstract int	compare0(long pageAddr, int off, org.gridgain.internal.h2.value.Value v, int type) Compares inlined and given value.
int	fullSize(long pageAddr, int off) Actual size of inline value.
@Nullable org.gridgain.internal.h2.value.Value	get(long pageAddr, int off, int maxSize) Restores value from inline, if possible.
protected abstract @Nullable org.gridgain.internal.h2.value.Value	get0(long pageAddr, int off) Restores value from inline.
int	inlineSizeOf(org.gridgain.internal.h2.value.Value val) Calculate size required to inline given value.
protected abstract int	inlineSizeOf0(org.gridgain.internal.h2.value.Value val) Calculate size required to inline given value.
int	put(long pageAddr, int off, org.gridgain.internal.h2.value.Value val, int maxSize) Puts given value into inline index tree.
protected abstract int	put0(long pageAddr, int off, org.gridgain.internal.h2.value.Value val, int maxSize) Puts given value into inline index tree.
protected byte[]	readBytes(long pageAddr, int off) Read variable length bytearray
short	size() Size required to inline value of type InlineIndexColumn.type().
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

Constructor Detail

AbstractInlineIndexColumn

protected AbstractInlineIndexColumn(org.gridgain.internal.h2.table.Column col,
                                    int type,
                                    short size)

Parameters:

col - Column.

type - Index type (see Value).

size - Size.

Method Detail

columnName

public String columnName()

Returns name of the inlined column.

Specified by:

columnName in interface InlineIndexColumn

Returns:

Name of the column.

type

public int type()

Returns type of inlined column.

Specified by:

type in interface InlineIndexColumn

Returns:

Integer code of the column's value type.

See Also:

Value

columnIndex

public int columnIndex()

Returns index of the inlined column.

Specified by:

columnIndex in interface InlineIndexColumn

Returns:

Index of the column.

size

public short size()

Size required to inline value of type InlineIndexColumn.type().

Specified by:

size in interface InlineIndexColumn

Returns:

Amount of bytes required for fixed-size types or -1 for types with variable length.

fullSize

public int fullSize(long pageAddr,
                    int off)

Actual size of inline value. It returns size() + 1 for values with fixed size and amount of written bytes for values with variable length.

Specified by:

fullSize in interface InlineIndexColumn

Parameters:

pageAddr - Page address.

off - Offset.

Returns:

Returns actual size of inlined value.

columnSql

public String columnSql()

Returns sql representation of the inlined column.

Specified by:

columnSql in interface InlineIndexColumn

Returns:

Sql representation of the column.

get

@Nullable
public @Nullable org.gridgain.internal.h2.value.Value get(long pageAddr,
                                                                    int off,
                                                                    int maxSize)

Restores value from inline, if possible.

Parameters:

pageAddr - Address of the page.

off - Offset on the page.

maxSize - Maxim size.

Returns:

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

compare

public int compare(long pageAddr,
                   int off,
                   int maxSize,
                   org.gridgain.internal.h2.value.Value v,
                   Comparator<org.gridgain.internal.h2.value.Value> comp)

Compares inlined and given value.

Specified by:

compare in interface InlineIndexColumn

Parameters:

pageAddr - Page address.

off - Offset.

maxSize - Max size.

v - Value that should be compare.

comp - Comparator.

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.

inlineSizeOf

public int inlineSizeOf(org.gridgain.internal.h2.value.Value val)

Calculate size required to inline given value.

Specified by:

inlineSizeOf in interface InlineIndexColumn

Parameters:

val - Value to calculate inline size.

Returns:

Calculated inline size.

put

public int put(long pageAddr,
               int off,
               org.gridgain.internal.h2.value.Value val,
               int maxSize)

Puts given value into inline index tree.

Specified by:

put in interface InlineIndexColumn

Parameters:

pageAddr - Page address.

off - Offset.

val - Value.

maxSize - Max size.

Returns:

Amount of bytes actually stored.

compare0

protected abstract int compare0(long pageAddr,
                                int off,
                                org.gridgain.internal.h2.value.Value v,
                                int type)

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.

put0

protected abstract int put0(long pageAddr,
                            int off,
                            org.gridgain.internal.h2.value.Value 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 @Nullable org.gridgain.internal.h2.value.Value 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.

inlineSizeOf0

protected abstract int inlineSizeOf0(org.gridgain.internal.h2.value.Value val)

Calculate size required to inline given value.

Parameters:

val - Value to calculate inline size.

Returns:

Calculated inline size.

readBytes

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

Read variable length bytearray