Package com.illumon.iris.db.tables.appendable

Interface AppendableColumn<DATA_TYPE>

All Known Subinterfaces:
BufferedAppendableColumn<DATA_TYPE>
All Known Implementing Classes:
ArrayVariableWidthObjectLocalAppendableColumn, BaseAppendableColumn, BlobStreamAppendableColumn, BufferVariableWidthObjectLocalAppendableColumn, CharSequenceLocalAppendableColumn, CompressedStringLocalAppendableColumn, DateTimeLocalAppendableColumn, DateTimeStreamAppendableColumn, ExternalizableLocalAppendableColumn, ExternalizableStreamAppendableColumn, FixedWidthObjectCodecLocalAppendableColumn, InstantLocalAppendableColumn, LocalAppendableColumn, NanosBackedTimeAppendableColumn, SerializableLocalAppendableColumn, SerializableStreamAppendableColumn, StreamAppendableColumn, StringLocalAppendableColumn, StringStreamAppendableColumn, SymbolLocalAppendableColumn, SymbolManagerLocalAppendableColumn, SymbolSetLocalAppendableColumn, VariableWidthObjectCodecLocalAppendableColumn, VariableWidthObjectLocalAppendableColumn
public interface AppendableColumn<DATA_TYPE>
Appendable columns for ordered output.

  • Field Details

    • DEFAULT_CHUNK_CAPACITY

      static final int DEFAULT_CHUNK_CAPACITY
      The default capacity for chunked appends.

  • Method Details

    • getName

      String getName()
      The name of this column in the enclosing table.
      Returns:
      The name of this column

    • getType

      Class<DATA_TYPE> getType()
      Returns:
      the type of object contained within this column.

    • getAddHelper

      default AppendableColumnAddHelper<DATA_TYPE> getAddHelper()
      Get a type-appropriate helper instance for complex append operations.
      Returns:
      An add-helper for this column

    • force

      void force()
      Persist all added data.

    • close

      void close()
      Persist all added data and release any system resources consumed by this column.

    • addBoolean

      void addBoolean(Boolean value)
      Append a Boolean to this column.
      Parameters:
      value - The value to append

    • addByte

      void addByte(byte value)
      Append a byte to this column.
      Parameters:
      value - The value to append

    • addChar

      void addChar(char value)
      Append a char to this column.
      Parameters:
      value - The value to append

    • addDouble

      void addDouble(double value)
      Append a double to this column.
      Parameters:
      value - The value to append

    • addFloat

      void addFloat(float value)
      Append a float to this column.
      Parameters:
      value - The value to append

    • addInt

      void addInt(int value)
      Append a int to this column.
      Parameters:
      value - The value to append

    • addLong

      void addLong(long value)
      Append a long to this column.
      Parameters:
      value - The value to append

    • addShort

      void addShort(short value)
      Append a short to this column.
      Parameters:
      value - The value to append

    • add

      void add(DATA_TYPE value)
      Append a DATA_TYPE to this column.
      Parameters:
      value - The value to append

    • addBoolean

      void addBoolean(Boolean value, long count)
      Append a Boolean to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addByte

      void addByte(byte value, long count)
      Append a byte to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addChar

      void addChar(char value, long count)
      Append a char to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addDouble

      void addDouble(double value, long count)
      Append a double to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addFloat

      void addFloat(float value, long count)
      Append a float to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addInt

      void addInt(int value, long count)
      Append a int to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addLong

      void addLong(long value, long count)
      Append a long to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addShort

      void addShort(short value, long count)
      Append a short to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • add

      void add(DATA_TYPE value, long count)
      Append a DATA_TYPE to this column count times.
      Parameters:
      value - The value to append
      count - The number of times to append the value

    • addBooleans

      void addBooleans(@NotNull Boolean[] values, int startIndex, int length)
      Add Boolean values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addBytes

      void addBytes(@NotNull byte[] values, int startIndex, int length)
      Add byte values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addBytes

      void addBytes(@NotNull ByteBuffer buffer)
      Add byte values from a ByteBuffer, starting at buffer.position() and continuing to buffer.limit().
      Parameters:
      buffer - The buffer

    • addChars

      void addChars(@NotNull char[] values, int startIndex, int length)
      Add char values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addDoubles

      void addDoubles(@NotNull double[] values, int startIndex, int length)
      Add double values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addFloats

      void addFloats(@NotNull float[] values, int startIndex, int length)
      Add float values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addInts

      void addInts(@NotNull int[] values, int startIndex, int length)
      Add int values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addLongs

      void addLongs(@NotNull long[] values, int startIndex, int length)
      Add long values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addShorts

      void addShorts(@NotNull short[] values, int startIndex, int length)
      Add short values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • add

      void add(@NotNull DATA_TYPE[] values, int startIndex, int length)
      Add DATA_TYPE values from an array.
      Parameters:
      values - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addFromDataColumn

      @Deprecated default void addFromDataColumn(@NotNull DataColumn<DATA_TYPE> source, int sourcePosition)
      Deprecated.
      Add a value described by its position from a DataColumn.
      Parameters:
      source - The source DataColumn
      sourcePosition - The position within source that contains the value to be added

    • addFromColumnSource

      @Deprecated default void addFromColumnSource(@NotNull ColumnSource<DATA_TYPE> source, long sourceKey)
      Deprecated.
      Add a value described by its key from a ColumnSource.
      Parameters:
      source - The source ColumnSource
      sourceKey - The key within source that contains the value to be added

    • addFromColumnSource

      @Deprecated default void addFromColumnSource(@NotNull ColumnSource<DATA_TYPE> source, @NotNull long[] sourceKeys)
      Deprecated.
      Add values described by an array of their keys from a ColumnSource.
      Parameters:
      source - The source ColumnSource
      sourceKeys - The keys within source that contain the values to be added

    • addFromColumnSource

      @Deprecated default void addFromColumnSource(@NotNull ColumnSource<DATA_TYPE> source, @NotNull Index index)
      Deprecated.
      Add values described by an Index from a ColumnSource.
      Parameters:
      source - The source ColumnSource
      index - An index whose keys within source contain the values to be added

    • addFromColumnSource

      @Deprecated default void addFromColumnSource(@NotNull ColumnSource<DATA_TYPE> source, @NotNull PrimitiveIterator.OfLong keyIterator)
      Deprecated.
      Add values supplied by an iterator from a ColumnSource.
      Parameters:
      source - The source ColumnSource
      keyIterator - An iterator of keys within source that contain the values to be added

    • addFromBoxedValue

      default void addFromBoxedValue(DATA_TYPE value)
      Add a value, with type-specific unboxing and null-conversion for primitive wrapper classes.
      Parameters:
      value - The value to add

    • addFromBoxedValue

      default void addFromBoxedValue(DATA_TYPE value, long count)
      Add a value multiple times, with type-specific unboxing and null-conversion for primitive wrapper classes.
      Parameters:
      value - The value to add
      count - The number of times to add the value

    • addFromArray

      default void addFromArray(@NotNull Object array, int startIndex, int length)
      Add values from an array of the "correct" type. That is, a primitive array for columns of a primitive type, and an appropriately typed array of objects for all other columns. Non-array or incorrect types may result in an exception or undefined behavior.
      Parameters:
      array - The array of values
      startIndex - The index of the first value to add
      length - The total number of values to add

    • addFromBooleanChunk

      void addFromBooleanChunk(@NotNull ObjectChunk<Boolean,? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source ObjectChunk

    • addFromByteChunk

      void addFromByteChunk(@NotNull ByteChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source ByteChunk

    • addFromCharChunk

      void addFromCharChunk(@NotNull CharChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source CharChunk

    • addFromDoubleChunk

      void addFromDoubleChunk(@NotNull DoubleChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source DoubleChunk

    • addFromFloatChunk

      void addFromFloatChunk(@NotNull FloatChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source FloatChunk

    • addFromIntChunk

      void addFromIntChunk(@NotNull IntChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source IntChunk

    • addFromLongChunk

      void addFromLongChunk(@NotNull LongChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source LongChunk

    • addFromShortChunk

      void addFromShortChunk(@NotNull ShortChunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source ShortChunk

    • addFromObjectChunk

      void addFromObjectChunk(@NotNull ObjectChunk<DATA_TYPE,? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source ObjectChunk

    • addFromChunk

      default void addFromChunk(@NotNull Chunk<? extends Attributes.Values> source)
      Add all values from source in the range [0, source.size()).
      Parameters:
      source - The source Chunk

    • addFromChunkSource

      default void addFromChunkSource(@NotNull ChunkSource<? extends Attributes.Values> source, @NotNull OrderedKeys orderedKeys, int chunkCapacity)
      Add all values from source specified by orderedKeys in units of chunkCapacity.
      Parameters:
      source - The ChunkSource to get values from
      orderedKeys - The keys to get from source
      chunkCapacity - The unit of work for ChunkSource.getChunk(ChunkSource.GetContext, OrderedKeys) and addFromChunk(Chunk)

    • addFromChunkSource

      default void addFromChunkSource(@NotNull ChunkSource<? extends Attributes.Values> source, @NotNull OrderedKeys orderedKeys, int chunkCapacity, @Nullable SharedContext sharedContext)
      Add all values from source specified by orderedKeys in units of chunkCapacity.
      Parameters:
      source - The ChunkSource to get values from
      orderedKeys - The keys to get from source
      chunkCapacity - The unit of work for ChunkSource.getChunk(ChunkSource.GetContext, OrderedKeys) and addFromChunk(Chunk)
      sharedContext - An optional SharedContext for use in creating a ChunkSource.GetContext

    • addFromChunkSource

      default void addFromChunkSource(@NotNull ChunkSource.GetContext context, @NotNull ChunkSource<? extends Attributes.Values> source, @NotNull OrderedKeys orderedKeys)
      Get a chunk of values from source, and add them all.
      Parameters:
      context - A ChunkSource.GetContext made from source
      source - The ChunkSource to get values from
      orderedKeys - The keys to get from source