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

Class ColumnRegionObjectCached<T,ATTR extends Attributes.Values,OFFSET_LOOKUP_CACHE extends OffsetLookupCache<T,ChunkSource.FillContext>>

java.lang.Object

com.illumon.iris.db.v2.sources.regioned.ColumnRegionObjectCached<T,ATTR,OFFSET_LOOKUP_CACHE>

All Implemented Interfaces:

ChunkSource<ATTR>, DefaultChunkSource<ATTR>, FillContextMaker, GetContextMaker, Page<ATTR>, Page.WithDefaults<ATTR>, PagingChunkSource<ATTR>, ColumnRegion<ATTR>, ColumnRegionObject<T,ATTR>, Releasable, OffsetLookup<T,ChunkSource.FillContext>

public final class ColumnRegionObjectCached<T,ATTR extends Attributes.Values,OFFSET_LOOKUP_CACHE extends OffsetLookupCache<T,ChunkSource.FillContext>>
extends Object
implements ColumnRegionObject<T,ATTR>, OffsetLookup<T,ChunkSource.FillContext>, Page.WithDefaults<ATTR>

Column region interface for regions that support fetching objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ColumnRegionObjectCached.CacheFactory<T,OFFSET_LOOKUP_CACHE extends OffsetLookupCache<T,ChunkSource.FillContext>>

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

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

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

ColumnRegionObject.DictionaryKeysWrapper, ColumnRegionObject.IntDictionaryKeysWrapper, ColumnRegionObject.Null<T,ATTR extends Attributes.Any>

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
ColumnRegionObjectCached(ColumnRegionObjectCached.CacheFactory<T,OFFSET_LOOKUP_CACHE> cacheFactory, FillContextMaker fillContextMaker, ColumnRegionObject<T,ATTR> innerRegion)

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.
OFFSET_LOOKUP_CACHE	getCache()
ColumnRegionLong<Attributes.DictionaryKeys>	getDictionaryKeysRegion()	Get a view of this region as long dictionary keys.
ColumnRegionInt<Attributes.DictionaryKeys>	getDictionaryKeysRegionInt()	Get a view of this region as int dictionary keys.
ChunkType	getDictionaryRegionType()
ColumnRegionObject<T,ATTR>	getDictionaryValuesRegion()	Get a view of this region as dictionary values.
ColumnLocation	getLocation()
Class<?>	getNativeType()
T	getObject(long elementIndex)	Get a single object from this region.
T	getObject(ChunkSource.FillContext context, long elementIndex)	Get a single object from this region.
long	length()
T	lookup(long offset, ChunkSource.FillContext fillContext)
void	releaseCachedResources()	Release any resources held for caching purposes.
ColumnRegionObject<T,ATTR>	skipCache()	Get a version of this region that skips all internal value caching.
RegionVisitResult	supportsDictionaryFormat(ReadOnlyIndex.SearchIterator keysToVisit)	Check if this region can expose an alternate form as paired regions of long keys and DATA_TYPE values covering all of its row keys in keysToVisit.

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, specialMatch, supportsSpecialMatching

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

gatherDictionaryValuesRowSet

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

getChunk, getChunk, getChunkByFilling, makeFillContext, 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

ColumnRegionObjectCached

public ColumnRegionObjectCached(@NotNull
 ColumnRegionObjectCached.CacheFactory<T,OFFSET_LOOKUP_CACHE> cacheFactory,
 @Nullable
 FillContextMaker fillContextMaker,
 @NotNull
 ColumnRegionObject<T,ATTR> innerRegion)

Method Details

getCache

public OFFSET_LOOKUP_CACHE getCache()

getObject

public T getObject(@NotNull
 ChunkSource.FillContext context,
 long elementIndex)

Description copied from interface: ColumnRegionObject

Get a single object from this region.

Specified by:

getObject in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Parameters:

context - A ColumnRegionFillContext to enable resource caching where suitable, with current region index pointing to this region

elementIndex - Element (object) index in the table's address space

Returns:

The object value at the specified element (object) index

getObject

public T getObject(long elementIndex)

Description copied from interface: ColumnRegionObject

Get a single object from this region.

Specified by:

getObject in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Parameters:

elementIndex - Element (object) index in the table's address space

Returns:

The object value at the specified element (object) index

length

public long length()

Specified by:

length in interface Page<T>

Returns:

the length of this page.

getNativeType

public Class<?> getNativeType()

Specified by:

getNativeType in interface ChunkSource<T>

Specified by:

getNativeType in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

skipCache

public ColumnRegionObject<T,ATTR> skipCache()

Description copied from interface: ColumnRegionObject

Get a version of this region that skips all internal value caching.

Specified by:

skipCache in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Returns:

a view of this region that ignores any value caching.

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<T>

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

lookup

public T lookup(long offset,
 ChunkSource.FillContext fillContext)

Specified by:

lookup in interface OffsetLookup<T,ATTR extends Attributes.Values>

getDictionaryValuesRegion

public ColumnRegionObject<T,ATTR> getDictionaryValuesRegion()

Description copied from interface: ColumnRegionObject

Get a view of this region as dictionary values.

Specified by:

getDictionaryValuesRegion in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Returns:

A dictionary values region as specified by ColumnRegionObject.supportsDictionaryFormat(Index.SearchIterator)

getDictionaryKeysRegionInt

public ColumnRegionInt<Attributes.DictionaryKeys> getDictionaryKeysRegionInt()

Description copied from interface: ColumnRegionObject

Get a view of this region as int dictionary keys.

Specified by:

getDictionaryKeysRegionInt in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Returns:

A dictionary keys region as specified by ColumnRegionObject.supportsDictionaryFormat(Index.SearchIterator)

getDictionaryKeysRegion

public ColumnRegionLong<Attributes.DictionaryKeys> getDictionaryKeysRegion()

Description copied from interface: ColumnRegionObject

Get a view of this region as long dictionary keys.

Specified by:

getDictionaryKeysRegion in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Returns:

A dictionary keys region as specified by ColumnRegionObject.supportsDictionaryFormat(Index.SearchIterator)

getDictionaryRegionType

public ChunkType getDictionaryRegionType()

Specified by:

getDictionaryRegionType in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

supportsDictionaryFormat

public RegionVisitResult supportsDictionaryFormat(@NotNull
 ReadOnlyIndex.SearchIterator keysToVisit)

Description copied from interface: ColumnRegionObject

Check if this region can expose an alternate form as paired regions of long keys and DATA_TYPE values covering all of its row keys in keysToVisit.

Both alternate regions must use the same or smaller row key space as this one. Indices fetched from the keys region must represent valid element indices in the values region. Values regions must support ColumnRegionObject.gatherDictionaryValuesRowSet(Index.SearchIterator, Index.Iterator, Index.SequentialBuilder).

Use ColumnRegionObject.getDictionaryKeysRegion() to access the region of keys and ColumnRegionObject.getDictionaryValuesRegion() to access the region of values.

Specified by:

supportsDictionaryFormat in interface ColumnRegionObject<T,ATTR extends Attributes.Values>

Parameters:

keysToVisit - Iterator positioned at the first relevant row key belonging to this region. Will be advanced to after this region if true is returned. No guarantee is made if false is returned.

Returns:

A RegionVisitResult specifying FAILED if this region cannot supply a dictionary, CONTINUE if it can and keysToVisit is not exhausted, and COMPLETE if it can and keysToVisit is exhausted

getLocation

public ColumnLocation getLocation()

Specified by:

getLocation in interface ColumnRegion<T>

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<T>

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<T>

Parameters:

keys - the keys to search for

Returns:

true if the region possibly contains the values

chunkMatch

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

Specified by:

chunkMatch in interface ColumnRegion<T>