Package org.apache.pinot.segment.spi.index.creator

Interface ForwardIndexCreator

    • Method Summary

      Modifier and Type Method Description
      FieldSpec.DataType getValueType()
      Returns the data type of the values in the forward index.
      boolean isDictionaryEncoded()
      Returns true if the forward index is dictionary-encoded, false if it is raw.
      boolean isSingleValue()
      Returns true if the forward index is for a single-value column, false if it is for a multi-value column.
      default void putBigDecimal​(BigDecimal value)
      Writes the next BIG_DECIMAL type single-value into the forward index.
      default void putBytes​(byte[] value)
      Writes the next BYTES type single-value into the forward index.
      default void putBytesMV​(byte[][] values)
      Writes the next byte[] type multi-value into the forward index.
      default void putDictId​(int dictId)
      Writes the dictionary id for the next single-value into the forward index.
      default void putDictIdMV​(int[] dictIds)
      Writes the dictionary ids for the next multi-value into the forward index.
      default void putDouble​(double value)
      Writes the next DOUBLE type single-value into the forward index.
      default void putDoubleMV​(double[] values)
      Writes the next DOUBLE type multi-value into the forward index.
      default void putFloat​(float value)
      Writes the next FLOAT type single-value into the forward index.
      default void putFloatMV​(float[] values)
      Writes the next FLOAT type multi-value into the forward index.
      default void putInt​(int value)
      Writes the next INT type single-value into the forward index.
      default void putIntMV​(int[] values)
      Writes the next INT type multi-value into the forward index.
      default void putLong​(long value)
      Writes the next LONG type single-value into the forward index.
      default void putLongMV​(long[] values)
      Writes the next LONG type multi-value into the forward index.
      default void putString​(String value)
      Writes the next STRING type single-value into the forward index.
      default void putStringMV​(String[] values)
      Writes the next STRING type multi-value into the forward index.

    • Method Detail

      • isDictionaryEncoded

        boolean isDictionaryEncoded()
        Returns true if the forward index is dictionary-encoded, false if it is raw.

      • isSingleValue

        boolean isSingleValue()
        Returns true if the forward index is for a single-value column, false if it is for a multi-value column.

      • putDictId

        default void putDictId​(int dictId)
        Writes the dictionary id for the next single-value into the forward index.
        Parameters:
        dictId - Document id to write

      • putDictIdMV

        default void putDictIdMV​(int[] dictIds)
        Writes the dictionary ids for the next multi-value into the forward index.
        Parameters:
        dictIds - Document ids to write

      • putInt

        default void putInt​(int value)
        Writes the next INT type single-value into the forward index.
        Parameters:
        value - Value to write

      • putLong

        default void putLong​(long value)
        Writes the next LONG type single-value into the forward index.
        Parameters:
        value - Value to write

      • putFloat

        default void putFloat​(float value)
        Writes the next FLOAT type single-value into the forward index.
        Parameters:
        value - Value to write

      • putDouble

        default void putDouble​(double value)
        Writes the next DOUBLE type single-value into the forward index.
        Parameters:
        value - Value to write

      • putBigDecimal

        default void putBigDecimal​(BigDecimal value)
        Writes the next BIG_DECIMAL type single-value into the forward index.
        Parameters:
        value - Value to write

      • putString

        default void putString​(String value)
        Writes the next STRING type single-value into the forward index.
        Parameters:
        value - Value to write

      • putBytes

        default void putBytes​(byte[] value)
        Writes the next BYTES type single-value into the forward index.
        Parameters:
        value - Value to write

      • putIntMV

        default void putIntMV​(int[] values)
        Writes the next INT type multi-value into the forward index.
        Parameters:
        values - Values to write

      • putLongMV

        default void putLongMV​(long[] values)
        Writes the next LONG type multi-value into the forward index.
        Parameters:
        values - Values to write

      • putFloatMV

        default void putFloatMV​(float[] values)
        Writes the next FLOAT type multi-value into the forward index.
        Parameters:
        values - Values to write

      • putDoubleMV

        default void putDoubleMV​(double[] values)
        Writes the next DOUBLE type multi-value into the forward index.
        Parameters:
        values - Values to write

      • putStringMV

        default void putStringMV​(String[] values)
        Writes the next STRING type multi-value into the forward index.
        Parameters:
        values - Values to write

      • putBytesMV

        default void putBytesMV​(byte[][] values)
        Writes the next byte[] type multi-value into the forward index.
        Parameters:
        values - Values to write