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

Class BoxedColumnSource<DATA_TYPE>

java.lang.Object

com.illumon.iris.db.v2.sources.AbstractColumnSource<DATA_TYPE>

com.illumon.iris.db.v2.sources.BoxedColumnSource<DATA_TYPE>

All Implemented Interfaces:

ChunkSource<Attributes.Values>, ChunkSource.WithPrev<Attributes.Values>, DefaultChunkSource<Attributes.Values>, DefaultChunkSource.WithPrev<Attributes.Values>, FillContextMaker, GetContextMaker, ColumnSource<DATA_TYPE>, ColumnSourceGetDefaults.ForObject<DATA_TYPE>, ElementSource<DATA_TYPE>, MutableColumnSource<DATA_TYPE>, MutableColumnSourceGetDefaults.ForObject<DATA_TYPE>, Releasable, TupleExporter<DATA_TYPE>, TupleSource<DATA_TYPE>, Serializable

Direct Known Subclasses:

BoxedColumnSource.OfDateTime

public abstract class BoxedColumnSource<DATA_TYPE>
extends AbstractColumnSource<DATA_TYPE>
implements MutableColumnSourceGetDefaults.ForObject<DATA_TYPE>

ColumnSource implementation for explicitly boxing a primitive into a more complex type, e.g. byte as Boolean or long as DBDateTime.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BoxedColumnSource.OfDateTime

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.sources.AbstractColumnSource

AbstractColumnSource.DefaultedImmutable<DATA_TYPE>, AbstractColumnSource.DefaultedMutable<DATA_TYPE>, AbstractColumnSource.IsSerializable

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.chunk.DefaultChunkSource

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

Field Summary

Fields inherited from class com.illumon.iris.db.v2.sources.AbstractColumnSource

componentType, type

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.chunk.ChunkSource.WithPrev

ZERO_LENGTH_CHUNK_SOURCE_WITH_PREV_ARRAY

Fields inherited from interface com.illumon.iris.db.v2.sources.ColumnSource

ZERO_LENGTH_COLUMN_SOURCE_ARRAY

Method Summary

Modifier and Type	Method	Description
<ALTERNATE_DATA_TYPE> boolean	allowsReinterpret(Class<ALTERNATE_DATA_TYPE> alternateDataType)	Test if a reinterpret call will succeed.
protected <ALTERNATE_DATA_TYPE> ColumnSource<ALTERNATE_DATA_TYPE>	doReinterpret(Class<ALTERNATE_DATA_TYPE> alternateDataType)	Supply allowed reinterpret results.
void	fillChunk(ChunkSource.FillContext context, WritableChunk<? super Attributes.Values> destination, OrderedKeys orderedKeys)	Populates the given destination chunk with data corresponding to the keys from the given OrderedKeys.
void	fillPrevChunk(ChunkSource.FillContext context, WritableChunk<? super Attributes.Values> destination, OrderedKeys orderedKeys)	Populates the given destination chunk with data corresponding to the keys from the given OrderedKeys.
abstract DATA_TYPE	get(long index)	Get the value from the source.
abstract DATA_TYPE	getPrev(long index)	Get the previous value at the index.
boolean	isImmutable()	Determine if this column source is immutable, meaning that the values at a given index key never change.
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.

Methods inherited from class com.illumon.iris.db.v2.sources.AbstractColumnSource

defaultFillChunk, getComponentType, getGroupingBuilder, getGroupingProvider, getNativeType, getType, hasGrouping, isSerializable, match, reinterpret, setGroupingProvider

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

cast, createPreviousTuple, createTuple, createTupleFromValues, exportElement, exportElement, exportToExternalKey, getColumnSources, getComponentType, getGroupingBuilder, getGroupingProvider, getNativeType, getPrevSource, getType, hasGrouping, match, reinterpret, releaseCachedResources, setGroupingProvider, startTrackingPrevValues

Methods inherited from interface com.illumon.iris.db.v2.sources.ColumnSourceGetDefaults.ForObject

getBoolean, getByte, getChar, getDouble, getFloat, getInt, getLong, getShort

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.DefaultChunkSource.WithPrev

getPrevChunk, getPrevChunk, getPrevChunkByFilling

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.MutableColumnSourceGetDefaults.ForObject

getPrevBoolean, getPrevByte, getPrevChar, getPrevDouble, getPrevFloat, getPrevInt, getPrevLong, getPrevShort

Methods inherited from interface com.illumon.iris.db.v2.tuples.TupleExporter

exportElementReinterpreted

Methods inherited from interface com.illumon.iris.db.v2.tuples.TupleSource

createTupleFromReinterpretedValues

Method Details

get

public abstract DATA_TYPE get(long index)

Description copied from interface: ElementSource

Get the value from the source. This may return boxed values for basic types.

Specified by:

get in interface ElementSource<DATA_TYPE>

Parameters:

index - the location in index space to get the value from.

Returns:

the value at the index, potentially null.

getPrev

public abstract DATA_TYPE getPrev(long index)

Description copied from interface: ElementSource

Get the previous value at the index. Previous values are used during an LTM update cycle to process changes in data. During normal operation previous values will be identical to current values.

Specified by:

getPrev in interface ElementSource<DATA_TYPE>

Parameters:

index - the location in index space to get the value from.

Returns:

the previous value at the index, or null.

makeFillContext

public final ChunkSource.FillContext makeFillContext(int chunkCapacity, 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<DATA_TYPE>

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

fillChunk

public final void fillChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Attributes.Values> destination, @NotNull OrderedKeys orderedKeys)

Description copied from interface: ChunkSource

Populates the given destination chunk with data corresponding to the keys from the given OrderedKeys.

Specified by:

fillChunk in interface ChunkSource<DATA_TYPE>

Overrides:

fillChunk in class AbstractColumnSource<DATA_TYPE>

Parameters:

context - A context containing all mutable/state related data used in retrieving the Chunk.

destination - The chunk to be populated according to orderedKeys. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,orderedKeys.size()).

orderedKeys - An OrderedKeys representing the keys to be fetched

fillPrevChunk

public final void fillPrevChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Attributes.Values> destination, @NotNull OrderedKeys orderedKeys)

Description copied from interface: ChunkSource.WithPrev

Populates the given destination chunk with data corresponding to the keys from the given OrderedKeys.

Specified by:

fillPrevChunk in interface ChunkSource.WithPrev<DATA_TYPE>

Overrides:

fillPrevChunk in class AbstractColumnSource<DATA_TYPE>

Parameters:

context - A context containing all mutable/state related data used in retrieving the Chunk.

destination - The chunk to be populated according to orderedKeys. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,orderedKeys.size()).

orderedKeys - An OrderedKeys representing the keys to be fetched

isImmutable

public final boolean isImmutable()

Description copied from interface: ColumnSource

Determine if this column source is immutable, meaning that the values at a given index key never change.

Specified by:

isImmutable in interface ColumnSource<DATA_TYPE>

Specified by:

isImmutable in interface MutableColumnSource<DATA_TYPE>

Returns:

true if the values at a given index of the column source never change, false otherwise

allowsReinterpret

public final <ALTERNATE_DATA_TYPE> boolean allowsReinterpret(@NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)

Description copied from interface: ColumnSource

Test if a reinterpret call will succeed.

Specified by:

allowsReinterpret in interface ColumnSource<DATA_TYPE>

Overrides:

allowsReinterpret in class AbstractColumnSource<DATA_TYPE>

Type Parameters:

ALTERNATE_DATA_TYPE - the dataType to inquire about

Parameters:

alternateDataType - The alternative type to consider

Returns:

If a reinterpret on this column source with the supplied alternateDataType will succeed.

doReinterpret

protected final <ALTERNATE_DATA_TYPE> ColumnSource<ALTERNATE_DATA_TYPE> doReinterpret(@NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)

Description copied from class: AbstractColumnSource

Supply allowed reinterpret results. The default implementation handles the most common case to avoid code duplication.

Overrides:

doReinterpret in class AbstractColumnSource<DATA_TYPE>

Type Parameters:

ALTERNATE_DATA_TYPE - the dataType to reinterpret to

Parameters:

alternateDataType - The alternate data type

Returns:

The resulting ColumnSource