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

Class InlineIndexImpl

java.lang.Object

org.apache.ignite.internal.cache.query.index.AbstractIndex

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

All Implemented Interfaces:

Index, InlineIndex, SortedSegmentedIndex

public class InlineIndexImpl
extends AbstractIndex
implements InlineIndex

Sorted index implementation.

Constructor Summary

Constructors

Constructor and Description
InlineIndexImpl(GridCacheContext<?,?> cctx, SortedIndexDefinition def, InlineIndexTree[] segments, IoStatisticsHolderIndex stats) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(CacheDataRow row) Checks whether index handles specified cache row.
long	count(int segment) Counts index rows in specified tree segment.
long	count(int segment, IndexQueryContext qryCtx) Counts index rows in specified tree segment with cache filter.
boolean	created() true if index is created and false if it is restored from disk.
void	destroy(boolean softDelete) Destroy index.
GridCursor<IndexRow>	find(IndexRow lower, IndexRow upper, int segment) Finds index rows by specified range in specified tree segment.
GridCursor<IndexRow>	find(IndexRow lower, IndexRow upper, int segment, IndexQueryContext qryCtx) Finds index rows by specified range in specifed tree segment with cache filtering.
GridCursor<IndexRow>	findFirst(int segment, IndexQueryContext qryCtx) Finds first index row for specified tree segment and cache filter.
GridCursor<IndexRow>	findLast(int segment, IndexQueryContext qryCtx) Finds last index row for specified tree segment and cache filter.
UUID	id() Unique ID.
int	inlineSize()
IndexKeyTypeSettings	keyTypeSettings()
String	name() Index name.
void	onUpdate(@Nullable CacheDataRow oldRow, @Nullable CacheDataRow newRow, boolean prevRowAvailable) Callback that runs when the underlying cache is updated.
void	putIndexRow(IndexRowImpl row) Put index row to index.
InlineIndexTree	segment(int segment)
int	segmentForRow(CacheDataRow row)
int	segmentsCount() Returns amount of index tree segments.
long	totalCount() Returns number of elements in the tree by scanning pages of the bottom (leaf) level.
<T extends Index> T	unwrap(Class<T> clazz) Provides a standard way to access the underlying concrete index implementation to provide access to further, proprietary features.

Methods inherited from class org.apache.ignite.internal.cache.query.index.AbstractIndex

markIndexRebuild, rebuildInProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineIndexImpl

public InlineIndexImpl(GridCacheContext<?,?> cctx,
                       SortedIndexDefinition def,
                       InlineIndexTree[] segments,
                       IoStatisticsHolderIndex stats)

Constructor.

Method Detail

find

public GridCursor<IndexRow> find(IndexRow lower,
                                 IndexRow upper,
                                 int segment)
                          throws IgniteCheckedException

Finds index rows by specified range in specified tree segment. Range can be bound or unbound.

Specified by:

find in interface SortedSegmentedIndex

Parameters:

lower - Nullable lower bound.

upper - Nullable upper bound.

segment - Number of tree segment to find.

Returns:

Cursor of found index rows.

Throws:

IgniteCheckedException

find

public GridCursor<IndexRow> find(IndexRow lower,
                                 IndexRow upper,
                                 int segment,
                                 IndexQueryContext qryCtx)
                          throws IgniteCheckedException

Finds index rows by specified range in specifed tree segment with cache filtering. Range can be bound or unbound.

Specified by:

find in interface SortedSegmentedIndex

Parameters:

lower - Nullable lower bound.

upper - Nullable upper bound.

segment - Number of tree segment to find.

qryCtx - External index qyery context.

Returns:

Cursor of found index rows.

Throws:

IgniteCheckedException

count

public long count(int segment)
           throws IgniteCheckedException

Counts index rows in specified tree segment.

Specified by:

count in interface SortedSegmentedIndex

Parameters:

segment - Number of tree segment to find.

Returns:

count of index rows for specified segment.

Throws:

IgniteCheckedException

count

public long count(int segment,
                  IndexQueryContext qryCtx)
           throws IgniteCheckedException

Counts index rows in specified tree segment with cache filter.

Specified by:

count in interface SortedSegmentedIndex

Parameters:

segment - Number of tree segment to find.

qryCtx - Index query context.

Returns:

count of index rows for specified segment.

Throws:

IgniteCheckedException

totalCount

public long totalCount()
                throws IgniteCheckedException

Returns number of elements in the tree by scanning pages of the bottom (leaf) level.

Specified by:

totalCount in interface SortedSegmentedIndex

Returns:

Number of elements in the tree.

Throws:

IgniteCheckedException - If failed.

findFirst

public GridCursor<IndexRow> findFirst(int segment,
                                      IndexQueryContext qryCtx)
                               throws IgniteCheckedException

Finds first index row for specified tree segment and cache filter.

Specified by:

findFirst in interface SortedSegmentedIndex

Parameters:

segment - Number of tree segment to find.

qryCtx - External index qyery context.

Returns:

Cursor of found index rows.

Throws:

IgniteCheckedException

findLast

public GridCursor<IndexRow> findLast(int segment,
                                     IndexQueryContext qryCtx)
                              throws IgniteCheckedException

Finds last index row for specified tree segment and cache filter.

Specified by:

findLast in interface SortedSegmentedIndex

Parameters:

segment - Number of tree segment to find.

qryCtx - External index qyery context.

Returns:

Cursor of found index rows.

Throws:

IgniteCheckedException

id

public UUID id()

Unique ID.

Specified by:

id in interface Index

name

public String name()

Index name.

Specified by:

name in interface Index

onUpdate

public void onUpdate(@Nullable
                     @Nullable CacheDataRow oldRow,
                     @Nullable
                     @Nullable CacheDataRow newRow,
                     boolean prevRowAvailable)
              throws IgniteCheckedException

Callback that runs when the underlying cache is updated.

Specified by:

onUpdate in interface Index

Parameters:

oldRow - Cache row that was replaced with newRow.

newRow - Cache row that was stored.

prevRowAvailable - Whether oldRow available.

Throws:

IgniteCheckedException

putIndexRow

public void putIndexRow(IndexRowImpl row)
                 throws IgniteCheckedException

Put index row to index. This method is for internal use only.

Parameters:

row - Index row.

Throws:

IgniteCheckedException

unwrap

public <T extends Index> T unwrap(Class<T> clazz)

Provides a standard way to access the underlying concrete index implementation to provide access to further, proprietary features.

Specified by:

unwrap in interface Index

inlineSize

public int inlineSize()

Specified by:

inlineSize in interface InlineIndex

Returns:

amount of bytes to store inlined index keys.

keyTypeSettings

public IndexKeyTypeSettings keyTypeSettings()

segmentsCount

public int segmentsCount()

Returns amount of index tree segments.

Specified by:

segmentsCount in interface SortedSegmentedIndex

Returns:

amount of index tree segments.

segmentForRow

public int segmentForRow(CacheDataRow row)

Parameters:

row - cache row.

Returns:

Segment ID for given key

created

public boolean created()

true if index is created and false if it is restored from disk.

Specified by:

created in interface InlineIndex

segment

public InlineIndexTree segment(int segment)

Specified by:

segment in interface InlineIndex

Parameters:

segment - Number of tree segment.

Returns:

Tree segment for specified number.

destroy

public void destroy(boolean softDelete)

Destroy index.

Specified by:

destroy in interface Index

Parameters:

softDelete - if true then perform logical deletion.

canHandle

public boolean canHandle(CacheDataRow row)
                  throws IgniteCheckedException

Checks whether index handles specified cache row.

Specified by:

canHandle in interface Index

Parameters:

row - Cache row.

Returns:

Whether index handles specified cache row

Throws:

IgniteCheckedException