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

Class BitMaskingColumnSource<T>

java.lang.Object

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

com.illumon.iris.db.v2.sources.BitMaskingColumnSource<T>

All Implemented Interfaces:

ChunkSource<Attributes.Values>, ChunkSource.WithPrev<Attributes.Values>, DefaultChunkSource<Attributes.Values>, DefaultChunkSource.WithPrev<Attributes.Values>, FillContextMaker, GetContextMaker, ColumnSource<T>, ElementSource<T>, Releasable, UngroupableColumnSource, TupleExporter<T>, TupleSource<T>, Serializable

public class BitMaskingColumnSource<T>
extends AbstractColumnSource<T>
implements UngroupableColumnSource

See Also:

Serialized Form

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
BitMaskingColumnSource(ZeroKeyCrossJoinShiftState shiftState, ColumnSource<T> innerSource)

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.
T	get(long index)	Get the value from the source.
Boolean	getBoolean(long index)	Get the value at the index as a Boolean.
byte	getByte(long index)	Get the value at the index as a byte.
char	getChar(long index)	Get the value at the index as a char.
Class<?>	getComponentType()
double	getDouble(long index)	Get the value at the index as a double.
float	getFloat(long index)	Get the value at the index as a float.
int	getInt(long index)	Get the value at the index as an int.
long	getLong(long index)	Get the value at the index as a long.
T	getPrev(long index)	Get the previous value at the index.
Boolean	getPrevBoolean(long index)	Get the previous value at the index as a Boolean.
byte	getPrevByte(long index)	Get the previous value at the index as a byte.
char	getPrevChar(long index)	Get the previous value at the index as a char.
double	getPrevDouble(long index)	Get the previous value at the index as a double.
float	getPrevFloat(long index)	Get the previous value at the index as a float.
int	getPrevInt(long index)	Get the previous value at the index as an int.
long	getPrevLong(long index)	Get the previous value at the index as a long.
short	getPrevShort(long index)	Get the previous value at the index as a short.
short	getShort(long index)	Get the value at the index as a short.
T	getUngrouped(long columnIndex, int arrayIndex)	Reach into a grouped column source and pull one element out of the array.
Boolean	getUngroupedBoolean(long columnIndex, int arrayIndex)
byte	getUngroupedByte(long columnIndex, int arrayIndex)
char	getUngroupedChar(long columnIndex, int arrayIndex)
double	getUngroupedDouble(long columnIndex, int arrayIndex)
float	getUngroupedFloat(long columnIndex, int arrayIndex)
int	getUngroupedInt(long columnIndex, int arrayIndex)
long	getUngroupedLong(long columnIndex, int arrayIndex)
T	getUngroupedPrev(long columnIndex, int arrayIndex)
Boolean	getUngroupedPrevBoolean(long columnIndex, int arrayIndex)
byte	getUngroupedPrevByte(long columnIndex, int arrayIndex)
char	getUngroupedPrevChar(long columnIndex, int arrayIndex)
double	getUngroupedPrevDouble(long columnIndex, int arrayIndex)
float	getUngroupedPrevFloat(long columnIndex, int arrayIndex)
int	getUngroupedPrevInt(long columnIndex, int arrayIndex)
long	getUngroupedPrevLong(long columnIndex, int arrayIndex)
short	getUngroupedPrevShort(long columnIndex, int arrayIndex)
long	getUngroupedPrevSize(long columnIndex)
short	getUngroupedShort(long columnIndex, int arrayIndex)
long	getUngroupedSize(long columnIndex)
boolean	isImmutable()	Determine if this column source is immutable, meaning that the values at a given index key never change.
boolean	isUngroupable()	Does this particular instance of the column source support ungrouping?
com.illumon.iris.db.v2.sources.BitMaskingColumnSource.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.
void	startTrackingPrevValues()	ColumnSource implementations that track previous values have the option to not actually start tracking previous values until this method is called.

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

defaultFillChunk, 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, getPrevSource

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.tuples.TupleExporter

exportElementReinterpreted

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

createTupleFromReinterpretedValues

Constructor Details

BitMaskingColumnSource

public BitMaskingColumnSource(ZeroKeyCrossJoinShiftState shiftState, @NotNull ColumnSource<T> innerSource)

Method Details

getComponentType

public Class<?> getComponentType()

Specified by:

getComponentType in interface ColumnSource<T>

Overrides:

getComponentType in class AbstractColumnSource<T>

startTrackingPrevValues

public void startTrackingPrevValues()

Description copied from interface: ColumnSource

ColumnSource implementations that track previous values have the option to not actually start tracking previous values until this method is called. This is an option, not an obligation: some simple ColumnSource implementations (like TSingleValueSource for various T) always track previous values; other implementations (like PrevColumnSource) never do; some (like TArrayColumnSource) only start tracking once this method is called. An immutable column source can not have distinct prev values; therefore it is implemented as a no-op.

Specified by:

startTrackingPrevValues in interface ColumnSource<T>

get

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

Parameters:

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

Returns:

the value at the index, potentially null.

getBoolean

public Boolean getBoolean(long index)

Description copied from interface: ElementSource

Get the value at the index as a Boolean.

Specified by:

getBoolean in interface ElementSource<T>

Parameters:

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

Returns:

the boolean at the index, potentially null.

getByte

public byte getByte(long index)

Description copied from interface: ElementSource

Get the value at the index as a byte.

Specified by:

getByte in interface ElementSource<T>

Parameters:

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

Returns:

the boolean at the index, null values are represented by QueryConstants.NULL_BYTE

getChar

public char getChar(long index)

Description copied from interface: ElementSource

Get the value at the index as a char.

Specified by:

getChar in interface ElementSource<T>

Parameters:

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

Returns:

the char at the index, null values are represented by QueryConstants.NULL_CHAR

getDouble

public double getDouble(long index)

Description copied from interface: ElementSource

Get the value at the index as a double.

Specified by:

getDouble in interface ElementSource<T>

Parameters:

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

Returns:

the double at the index, null values are represented by QueryConstants.NULL_DOUBLE

getFloat

public float getFloat(long index)

Description copied from interface: ElementSource

Get the value at the index as a float.

Specified by:

getFloat in interface ElementSource<T>

Parameters:

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

Returns:

the float at the index, null values are represented by QueryConstants.NULL_FLOAT

getInt

public int getInt(long index)

Description copied from interface: ElementSource

Get the value at the index as an int.

Specified by:

getInt in interface ElementSource<T>

Parameters:

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

Returns:

the int at the index, null values are represented by QueryConstants.NULL_INT

getLong

public long getLong(long index)

Description copied from interface: ElementSource

Get the value at the index as a long.

Specified by:

getLong in interface ElementSource<T>

Parameters:

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

Returns:

the long at the index, null values are represented by QueryConstants.NULL_LONG

getShort

public short getShort(long index)

Description copied from interface: ElementSource

Get the value at the index as a short.

Specified by:

getShort in interface ElementSource<T>

Parameters:

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

Returns:

the short at the index, null values are represented by QueryConstants.NULL_SHORT

getPrev

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

Parameters:

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

Returns:

the previous value at the index, or null.

getPrevBoolean

public Boolean getPrevBoolean(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a Boolean. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevBoolean in interface ElementSource<T>

Parameters:

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

Returns:

the previous boolean at the index, or null.

getPrevByte

public byte getPrevByte(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a byte. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevByte in interface ElementSource<T>

Parameters:

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

Returns:

the previous boolean at the index, null values are represented by QueryConstants.NULL_BYTE

getPrevChar

public char getPrevChar(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a char. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevChar in interface ElementSource<T>

Parameters:

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

Returns:

the previous char at the index, null values are represented by QueryConstants.NULL_CHAR

getPrevDouble

public double getPrevDouble(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a double. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevDouble in interface ElementSource<T>

Parameters:

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

Returns:

the previous double at the index, null values are represented by QueryConstants.NULL_DOUBLE

getPrevFloat

public float getPrevFloat(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a float. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevFloat in interface ElementSource<T>

Parameters:

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

Returns:

the previous float at the index, null values are represented by QueryConstants.NULL_FLOAT

getPrevInt

public int getPrevInt(long index)

Description copied from interface: ElementSource

Get the previous value at the index as an int. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevInt in interface ElementSource<T>

Parameters:

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

Returns:

the previous int at the index, null values are represented by QueryConstants.NULL_INT

getPrevLong

public long getPrevLong(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a long. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevLong in interface ElementSource<T>

Parameters:

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

Returns:

the previous long at the index, null values are represented by QueryConstants.NULL_LONG

getPrevShort

public short getPrevShort(long index)

Description copied from interface: ElementSource

Get the previous value at the index as a short. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevShort in interface ElementSource<T>

Parameters:

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

Returns:

the previous short at the index, null values are represented by QueryConstants.NULL_SHORT

isImmutable

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

Returns:

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

isUngroupable

public boolean isUngroupable()

Description copied from interface: UngroupableColumnSource

Does this particular instance of the column source support ungrouping?

Specified by:

isUngroupable in interface UngroupableColumnSource

Returns:

true if you can call the getUngrouped family of methods and get a valid answer.

getUngroupedSize

public long getUngroupedSize(long columnIndex)

Specified by:

getUngroupedSize in interface UngroupableColumnSource

Parameters:

columnIndex - the index within this column to interrogate

Returns:

the size of the DbArray at columnIndex.

getUngroupedPrevSize

public long getUngroupedPrevSize(long columnIndex)

Specified by:

getUngroupedPrevSize in interface UngroupableColumnSource

getUngrouped

public T getUngrouped(long columnIndex, int arrayIndex)

Description copied from interface: UngroupableColumnSource

Reach into a grouped column source and pull one element out of the array.

Specified by:

getUngrouped in interface UngroupableColumnSource

Parameters:

columnIndex - the index within the column of the cell to get

arrayIndex - the index within the array at the specified cell

Returns:

Equivalent to ((DbArray)columnSource.get(columnIndex)).get(arrayIndex)

getUngroupedPrev

public T getUngroupedPrev(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrev in interface UngroupableColumnSource

getUngroupedBoolean

public Boolean getUngroupedBoolean(long columnIndex, int arrayIndex)

Specified by:

getUngroupedBoolean in interface UngroupableColumnSource

getUngroupedPrevBoolean

public Boolean getUngroupedPrevBoolean(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevBoolean in interface UngroupableColumnSource

getUngroupedDouble

public double getUngroupedDouble(long columnIndex, int arrayIndex)

Specified by:

getUngroupedDouble in interface UngroupableColumnSource

getUngroupedPrevDouble

public double getUngroupedPrevDouble(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevDouble in interface UngroupableColumnSource

getUngroupedFloat

public float getUngroupedFloat(long columnIndex, int arrayIndex)

Specified by:

getUngroupedFloat in interface UngroupableColumnSource

getUngroupedPrevFloat

public float getUngroupedPrevFloat(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevFloat in interface UngroupableColumnSource

getUngroupedByte

public byte getUngroupedByte(long columnIndex, int arrayIndex)

Specified by:

getUngroupedByte in interface UngroupableColumnSource

getUngroupedPrevByte

public byte getUngroupedPrevByte(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevByte in interface UngroupableColumnSource

getUngroupedChar

public char getUngroupedChar(long columnIndex, int arrayIndex)

Specified by:

getUngroupedChar in interface UngroupableColumnSource

getUngroupedPrevChar

public char getUngroupedPrevChar(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevChar in interface UngroupableColumnSource

getUngroupedShort

public short getUngroupedShort(long columnIndex, int arrayIndex)

Specified by:

getUngroupedShort in interface UngroupableColumnSource

getUngroupedPrevShort

public short getUngroupedPrevShort(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevShort in interface UngroupableColumnSource

getUngroupedInt

public int getUngroupedInt(long columnIndex, int arrayIndex)

Specified by:

getUngroupedInt in interface UngroupableColumnSource

getUngroupedPrevInt

public int getUngroupedPrevInt(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevInt in interface UngroupableColumnSource

getUngroupedLong

public long getUngroupedLong(long columnIndex, int arrayIndex)

Specified by:

getUngroupedLong in interface UngroupableColumnSource

getUngroupedPrevLong

public long getUngroupedPrevLong(long columnIndex, int arrayIndex)

Specified by:

getUngroupedPrevLong in interface UngroupableColumnSource

releaseCachedResources

public void releaseCachedResources()

Description copied from interface: ColumnSource

Release any resources held for caching purposes. Implementations need not guarantee that concurrent accesses are correct, as the purpose of this method is to ensure cleanup for column sources that will no longer be used.

Specified by:

releaseCachedResources in interface ColumnSource<T>

Specified by:

releaseCachedResources in interface Releasable

allowsReinterpret

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

Overrides:

allowsReinterpret in class AbstractColumnSource<T>

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

Type Parameters:

ALTERNATE_DATA_TYPE - the dataType to reinterpret to

Parameters:

alternateDataType - The alternate data type

Returns:

The resulting ColumnSource

makeFillContext

public com.illumon.iris.db.v2.sources.BitMaskingColumnSource.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<T>

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

Overrides:

fillChunk in class AbstractColumnSource<T>

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

Overrides:

fillPrevChunk in class AbstractColumnSource<T>

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