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

Class CharacterArraySource

java.lang.Object

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

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

com.illumon.iris.db.v2.sources.CharacterArraySource

All Implemented Interfaces:

ChunkSource<Attributes.Values>, ChunkSource.WithPrev<Attributes.Values>, DefaultChunkSource<Attributes.Values>, DefaultChunkSource.WithPrev<Attributes.Values>, FillContextMaker, GetContextMaker, ColumnSource<Character>, ColumnSourceGetDefaults.ForChar, ElementSource<Character>, FillUnordered, MutableColumnSource<Character>, MutableColumnSourceGetDefaults.ForChar, Releasable, WritableChunkSink<Attributes.Values>, WritableSource<Character>, TupleExporter<Character>, TupleSource<Character>, ShiftData.ShiftCallback, Serializable

public class CharacterArraySource
extends ArrayBackedColumnSource<T>
implements MutableColumnSourceGetDefaults.ForChar

Simple array source for Character.

The C-haracterArraySource is replicated to all other types with com.illumon.iris.db.v2.sources.Replicate. (C-haracter is deliberately spelled that way in order to prevent Replicate from altering this very comment).

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

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

WritableChunkSink.FillFromContext

Field Summary

Fields

Modifier and Type	Field	Description
protected UpdateCommitter<com.illumon.iris.db.v2.sources.ArraySourceHelper<T,UArray>>	prevFlusher	The presence of a prevFlusher means that this ArraySource wants to track previous values.

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

BLOCK_SIZE

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

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

DEFAULT_FILL_FROM_INSTANCE

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

ZERO_LENGTH_WRITABLE_SOURCE_ARRAY

Constructor Summary

Constructors

Constructor	Description
CharacterArraySource()

Method Summary

Modifier and Type	Method	Description
void	copy(ColumnSource<Character> sourceColumn, long sourceKey, long destKey)
void	copyFromChunk(long firstKey, long totalLength, Chunk<? extends Attributes.Values> src, int offset)
void	ensureCapacity(long capacity)
void	ensureCapacity(long capacity, boolean nullFill)
void	fillFromChunk(WritableChunkSink.FillFromContext context, Chunk<? extends Attributes.Values> src, OrderedKeys orderedKeys)	Our default, inefficient, implementation.
void	fillFromChunkUnordered(WritableChunkSink.FillFromContext context, Chunk<? extends Attributes.Values> src, LongChunk<Attributes.KeyIndices> keys)	Fills the ChunkSink with data from the source, with data corresponding to the keys from the given key chunk.
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.
protected void	fillSparseChunk(WritableChunk<? super Attributes.Values> destGeneric, OrderedKeys indices)
protected void	fillSparseChunkUnordered(WritableChunk<? super Attributes.Values> destGeneric, LongChunk<? extends Attributes.KeyIndices> indices)
protected void	fillSparsePrevChunk(WritableChunk<? super Attributes.Values> destGeneric, OrderedKeys indices)
protected void	fillSparsePrevChunkUnordered(WritableChunk<? super Attributes.Values> destGeneric, LongChunk<? extends Attributes.KeyIndices> indices)
Character	get(long index)	Get the value from the source.
char	getAndSetUnsafe(long index, char newValue)
long	getCapacity()	Get the capacity of this column source.
char	getChar(long index)	Get the value at the index as a char.
Character	getPrev(long index)	Get the previous value at the index.
char	getPrevChar(long index)	Get the previous value at the index as a char.
char	getUnsafe(long index)
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
WritableChunkSink.FillFromContext	makeFillFromContext(int chunkCapacity)	Provide a default, empty WritableChunkSink.FillFromContext for use with our default WritableSource.fillFromChunk(com.illumon.iris.db.v2.sources.WritableChunkSink.FillFromContext, com.illumon.iris.db.v2.sources.chunk.Chunk<? extends com.illumon.iris.db.v2.sources.chunk.Attributes.Values>, com.illumon.iris.db.v2.utils.OrderedKeys).
void	move(long source, long dest, long length)
long	resetWritableChunkToBackingStore(ResettableWritableChunk chunk, long position)	Resets the given chunk to provide a write-through reference to our backing array.
void	set(long key, char value)
void	set(long key, Character value)
void	setNull(long key)
void	shift(long start, long end, long offset)
void	startTrackingPrevValues()	Force my inheritors to implement this method, rather than taking the interface default.

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

fillChunk, fillChunkUnordered, fillPrevChunkUnordered, getChunk, getDateTimeMemoryColumnSource, getDateTimeMemoryColumnSource, getImmutableMemoryColumnSource, getImmutableMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, isImmutable, set, set, set, set, set, set

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

allowsReinterpret, defaultFillChunk, doReinterpret, 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

fillChunk, getChunkType

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

fillPrevChunk

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

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

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

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

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

isImmutable

Methods inherited from interface com.illumon.iris.db.v2.sources.MutableColumnSourceGetDefaults.ForChar

getPrevBoolean, getPrevByte, 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

Methods inherited from interface com.illumon.iris.db.v2.sources.WritableSource

setNull

Field Details

prevFlusher

protected transient UpdateCommitter<com.illumon.iris.db.v2.sources.ArraySourceHelper<T,UArray>> prevFlusher

The presence of a prevFlusher means that this ArraySource wants to track previous values. If prevFlusher is null, the ArraySource does not want (or does not yet want) to track previous values. Deserialized ArraySources never track previous values.

Constructor Details

CharacterArraySource

public CharacterArraySource()

Method Details

startTrackingPrevValues

public void startTrackingPrevValues()

Force my inheritors to implement this method, rather than taking the interface default.

Specified by:

startTrackingPrevValues in interface ColumnSource<Character>

ensureCapacity

public void ensureCapacity(long capacity)

Specified by:

ensureCapacity in interface WritableSource<Character>

ensureCapacity

public void ensureCapacity(long capacity, boolean nullFill)

Specified by:

ensureCapacity in class ArrayBackedColumnSource<Character>

set

public final void set(long key, Character value)

Specified by:

set in interface WritableSource<Character>

set

public final void set(long key, char value)

Specified by:

set in interface WritableSource<Character>

Overrides:

set in class ArrayBackedColumnSource<Character>

setNull

public void setNull(long key)

Specified by:

setNull in interface WritableSource<Character>

get

public Character 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 ColumnSourceGetDefaults.ForChar

Specified by:

get in interface ElementSource<Character>

Parameters:

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

Returns:

the value at the index, potentially null.

getChar

public final char getChar(long index)

Description copied from interface: ElementSource

Get the value at the index as a char.

Specified by:

getChar in interface ElementSource<Character>

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

getUnsafe

public final char getUnsafe(long index)

getAndSetUnsafe

public final char getAndSetUnsafe(long index, char newValue)

getPrev

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

Specified by:

getPrev in interface MutableColumnSourceGetDefaults.ForChar

Parameters:

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

Returns:

the previous value at the index, or null.

getPrevChar

public final 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<Character>

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

copy

public void copy(ColumnSource<Character> sourceColumn, long sourceKey, long destKey)

Specified by:

copy in interface WritableSource<Character>

shift

public void shift(long start, long end, long offset)

Specified by:

shift in interface ShiftData.ShiftCallback

Overrides:

shift in class ArrayBackedColumnSource<Character>

move

public void move(long source, long dest, long length)

resetWritableChunkToBackingStore

public long resetWritableChunkToBackingStore(@NotNull ResettableWritableChunk chunk, long position)

Description copied from class: ArrayBackedColumnSource

Resets the given chunk to provide a write-through reference to our backing array. Note: This is unsafe to use if previous tracking has been enabled!

Specified by:

resetWritableChunkToBackingStore in class ArrayBackedColumnSource<Character>

Parameters:

chunk - the writable chunk to reset to our backing array.

position - position that we require

Returns:

the first position addressable by the chunk

fillSparseChunk

protected void fillSparseChunk(@NotNull WritableChunk<? super Attributes.Values> destGeneric, @NotNull OrderedKeys indices)

Specified by:

fillSparseChunk in class ArrayBackedColumnSource<Character>

fillSparsePrevChunk

protected void fillSparsePrevChunk(@NotNull WritableChunk<? super Attributes.Values> destGeneric, @NotNull OrderedKeys indices)

Specified by:

fillSparsePrevChunk in class ArrayBackedColumnSource<Character>

fillSparseChunkUnordered

protected void fillSparseChunkUnordered(@NotNull WritableChunk<? super Attributes.Values> destGeneric, @NotNull LongChunk<? extends Attributes.KeyIndices> indices)

Specified by:

fillSparseChunkUnordered in class ArrayBackedColumnSource<Character>

fillSparsePrevChunkUnordered

protected void fillSparsePrevChunkUnordered(@NotNull WritableChunk<? super Attributes.Values> destGeneric, @NotNull LongChunk<? extends Attributes.KeyIndices> indices)

Specified by:

fillSparsePrevChunkUnordered in class ArrayBackedColumnSource<Character>

copyFromChunk

public void copyFromChunk(long firstKey, long totalLength, Chunk<? extends Attributes.Values> src, int offset)

fillFromChunkUnordered

public void fillFromChunkUnordered(@NotNull WritableChunkSink.FillFromContext context, @NotNull Chunk<? extends Attributes.Values> src, @NotNull LongChunk<Attributes.KeyIndices> keys)

Description copied from interface: WritableChunkSink

Fills the ChunkSink with data from the source, with data corresponding to the keys from the given key chunk.

Specified by:

fillFromChunkUnordered in interface WritableChunkSink<Attributes.Values>

Specified by:

fillFromChunkUnordered in interface WritableSource<Character>

Parameters:

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

src - The source of the data orderedKeys

keys - A LongChunk representing the keys to be written

makeFillContext

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

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

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

getCapacity

public final long getCapacity()

Get the capacity of this column source. This number is one higher than the highest key that may be accessed (read or written).

Returns:

The capacity of this column source

makeFillFromContext

public WritableChunkSink.FillFromContext makeFillFromContext(int chunkCapacity)

Description copied from interface: WritableSource

Provide a default, empty WritableChunkSink.FillFromContext for use with our default WritableSource.fillFromChunk(com.illumon.iris.db.v2.sources.WritableChunkSink.FillFromContext, com.illumon.iris.db.v2.sources.chunk.Chunk<? extends com.illumon.iris.db.v2.sources.chunk.Attributes.Values>, com.illumon.iris.db.v2.utils.OrderedKeys).

fillFromChunk

public void fillFromChunk(@NotNull WritableChunkSink.FillFromContext context, @NotNull Chunk<? extends Attributes.Values> src, @NotNull OrderedKeys orderedKeys)

Description copied from interface: WritableSource

Our default, inefficient, implementation. Inheritors who care should provide a better implementation.

Parameters:

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

src - The source of the data orderedKeys

orderedKeys - An OrderedKeys representing the keys to be written