Package com.illumon.iris.db.v2.sources.regioned

Class ColumnRegionReferencingImpl<ATTR extends Attributes.Values,REFERENCED_COLUMN_REGION extends ColumnRegion<ATTR>>

java.lang.Object

com.illumon.iris.db.v2.sources.regioned.ColumnRegionReferencingImpl<ATTR,REFERENCED_COLUMN_REGION>

All Implemented Interfaces:

ChunkSource<ATTR>, DefaultChunkSource<ATTR>, FillContextMaker, GetContextMaker, Page<ATTR>, Page.WithDefaults<ATTR>, PagingChunkSource<ATTR>, ColumnRegion<ATTR>, ColumnRegionReferencing<ATTR,REFERENCED_COLUMN_REGION>, Releasable

public class ColumnRegionReferencingImpl<ATTR extends Attributes.Values,REFERENCED_COLUMN_REGION extends ColumnRegion<ATTR>>
extends Object
implements ColumnRegionReferencing<ATTR,REFERENCED_COLUMN_REGION>, Page.WithDefaults<ATTR>

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

ChunkSource.GetContext, ChunkSource.WithPrev<ATTR extends Attributes.Any>

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.regioned.ColumnRegionReferencing

ColumnRegionReferencing.Converter<ATTR extends Attributes.Any>, ColumnRegionReferencing.Null<ATTR extends Attributes.Any,REFERENCED_COLUMN_REGION extends ColumnRegion<ATTR>>

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.DefaultChunkSource

DefaultChunkSource.SupportsContiguousGet<ATTR extends Attributes.Any>, DefaultChunkSource.WithPrev<ATTR extends Attributes.Any>

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page

Page.WithDefaults<ATTR extends Attributes.Any>, Page.WithDefaultsForRepeatingValues<ATTR extends Attributes.Any>

Field Summary

Fields inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

DEFAULT_FILL_INSTANCE, ZERO_LENGTH_CHUNK_SOURCE_ARRAY

Fields inherited from interface com.illumon.iris.db.v2.sources.regioned.ColumnRegion

REGION_MASK

Constructor Summary

Constructors

Constructor	Description
ColumnRegionReferencingImpl(Class<?> nativeType, REFERENCED_COLUMN_REGION referencedColumnRegion, ColumnRegionReferencing.Converter<ATTR> converter)

Method Summary

Modifier and Type	Method	Description
Index	binSearchMatch(long firstKey, long lastKey, SortPair sortPair, Object[] keys)	Given that this column is sorted, match the input keys using a binary search.
Index	chunkMatch(long regionFirstKey, OrderedKeys keysToFilter, boolean caseInsensitive, boolean invertMatch, Object[] keys)
boolean	couldInclude(Object[] keys)	Check if the region could possibly include any of the keys we're searching for
void	fillChunkAppend(ChunkSource.FillContext context, WritableChunk<? super ATTR> destination, OrderedKeys orderedKeys)	Appends the values referenced by orderKeys onto destination.
ColumnLocation	getLocation()
Class<?>	getNativeType()
REFERENCED_COLUMN_REGION	getReferencedRegion()
long	length()
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
void	releaseCachedResources()	Release any resources held for caching purposes.
Index	specialMatch(OrderedKeys keysToFilter, long regionFirstKey, boolean caseInsensitive, boolean invertMatch, Object[] keys)	If ColumnRegion.supportsSpecialMatching() is true this method will perform matching in lieu of the standard RegionedColumnSourceBase.match(boolean, boolean, boolean, ReadOnlyIndex, Object...).
boolean	supportsSpecialMatching()	Check if this region has special matching features.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

getChunkType

Methods inherited from interface com.illumon.iris.db.v2.sources.regioned.ColumnRegion

firstRowOffset, mask

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.DefaultChunkSource

getChunk, getChunk, getChunkByFilling, makeGetContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.FillContextMaker

makeFillContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.GetContextMaker

makeGetContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page

advanceToNextPage, advanceToNextPage, advanceToNextPageAndGetPositionDistance, firstRow, getRowOffset, lastRow

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page.WithDefaults

fillChunk, fillChunkAppend

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.PagingChunkSource

maxRow

Constructor Details

ColumnRegionReferencingImpl

public ColumnRegionReferencingImpl(@NotNull
 Class<?> nativeType,
 @NotNull
 REFERENCED_COLUMN_REGION referencedColumnRegion,
 @NotNull
 ColumnRegionReferencing.Converter<ATTR> converter)

Method Details

getReferencedRegion

@NotNull
public REFERENCED_COLUMN_REGION getReferencedRegion()

Specified by:

getReferencedRegion in interface ColumnRegionReferencing<ATTR extends Attributes.Values,REFERENCED_COLUMN_REGION extends ColumnRegion<ATTR>>

getNativeType

public Class<?> getNativeType()

Specified by:

getNativeType in interface ChunkSource<ATTR extends Attributes.Values>

length

public long length()

Specified by:

length in interface Page<ATTR extends Attributes.Values>

Returns:

the length of this page.

fillChunkAppend

public void fillChunkAppend(@NotNull
 ChunkSource.FillContext context,
 @NotNull
 WritableChunk<? super ATTR> destination,
 @NotNull
 OrderedKeys orderedKeys)

Description copied from interface: Page.WithDefaults

Appends the values referenced by orderKeys onto destination. orderKeys are assumed to be entirely contained on this Page.

Specified by:

fillChunkAppend in interface Page.WithDefaults<ATTR extends Attributes.Values>

makeFillContext

public ChunkSource.FillContext makeFillContext(int chunkCapacity,
 @Nullable
 SharedContext sharedContext)

Description copied from interface: FillContextMaker

Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.

Specified by:

makeFillContext in interface DefaultChunkSource<ATTR extends Attributes.Values>

Specified by:

makeFillContext in interface FillContextMaker

Parameters:

chunkCapacity - The maximum size of any WritableChunk that will be filled with this context

sharedContext - Shared store of intermediate results.

Returns:

A context for use with fill operations

releaseCachedResources

@OverridingMethodsMustInvokeSuper
public void releaseCachedResources()

Description copied from interface: Releasable

Release any resources held for caching purposes. Implementations need not guarantee that they are safe for normal use concurrently with invocations of this method.

Specified by:

releaseCachedResources in interface Releasable

getLocation

public ColumnLocation getLocation()

Specified by:

getLocation in interface ColumnRegion<ATTR extends Attributes.Values>

binSearchMatch

public Index binSearchMatch(long firstKey,
 long lastKey,
 @NotNull
 SortPair sortPair,
 @NotNull
 Object[] keys)

Description copied from interface: ColumnRegion

Given that this column is sorted, match the input keys using a binary search.

Specified by:

binSearchMatch in interface ColumnRegion<ATTR extends Attributes.Values>

Parameters:

firstKey - The first key to search

lastKey - The last key to search

sortPair - the sorting definition

keys - the keys to search for, in no particular order

couldInclude

public boolean couldInclude(@NotNull
 Object[] keys)

Description copied from interface: ColumnRegion

Check if the region could possibly include any of the keys we're searching for

Specified by:

couldInclude in interface ColumnRegion<ATTR extends Attributes.Values>

Parameters:

keys - the keys to search for

Returns:

true if the region possibly contains the values

supportsSpecialMatching

public boolean supportsSpecialMatching()

Description copied from interface: ColumnRegion

Check if this region has special matching features.

Specified by:

supportsSpecialMatching in interface ColumnRegion<ATTR extends Attributes.Values>

Returns:

true if this has special matching features

specialMatch

public Index specialMatch(@NotNull
 OrderedKeys keysToFilter,
 long regionFirstKey,
 boolean caseInsensitive,
 boolean invertMatch,
 @NotNull
 Object[] keys)

Description copied from interface: ColumnRegion

If ColumnRegion.supportsSpecialMatching() is true this method will perform matching in lieu of the standard RegionedColumnSourceBase.match(boolean, boolean, boolean, ReadOnlyIndex, Object...).

Specified by:

specialMatch in interface ColumnRegion<ATTR extends Attributes.Values>

Parameters:

keysToFilter - the keys being filtered

regionFirstKey - the first key within this region

caseInsensitive - if the match is case insensitive

invertMatch - if the match should be inverted

keys - the keys to search for, in no particular order

Returns:

an index of matched rows

chunkMatch

public Index chunkMatch(long regionFirstKey,
 @NotNull
 OrderedKeys keysToFilter,
 boolean caseInsensitive,
 boolean invertMatch,
 @NotNull
 Object[] keys)

Specified by:

chunkMatch in interface ColumnRegion<ATTR extends Attributes.Values>