Package nom.tam.fits.compression.provider.param.api

Interface ICompressColumnParameter

All Superinterfaces:
ICompressParameter
All Known Implementing Classes:
CompressColumnParameter, ZBlankColumnParameter
public interface ICompressColumnParameter extends ICompressParameter

(for internal use) Compression parameters that are stored in the table along with the compressed data. Each parameter is associated to a comlumn in the table, and the parameter takes the value that is stored in the same row as the compressed data themselves.

It is possible to make independent copies of a set of such parameters, e.g. for parallel processing. In such cases all copies share their underlying column data with the original, so changing the sotrage array of column data in either the original or any of its decendants will affect the original and all decendans equally.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Object
    column()
    Deprecated.
    Provided for back compatibility only.
    default void
    column(Object column, int size)
    Deprecated.
    Provided for back compatibility only.
    Object
    getColumnData()
    Returns the data column, in which each entry stores the parameter value for the compressed data of the corresponding row in the table.
    void
    getValueFromColumn(int index)
    Updates the associated compression options to use the parameter value defined to the compressed tile of the specified index.
    default Object
    initializedColumn()
    Deprecated.
    Provided for back compatibility only.
    void
    setColumnData(Object column, int size)
    Sets new parameter data for each compressed row to be stored along as a separate parameter column in the compressed table.
    default void
    setValueFromColumn(int index)
    Deprecated.
    Provided for back compatibility only.
    void
    setValueInColumn(int index)
    Stores the current parameter value of the associated compression options for the tile of the specified index.

    Methods inherited from interface nom.tam.fits.compression.provider.param.api.ICompressParameter

    getName

  • Method Details

    • getColumnData

      Object getColumnData()
      Returns the data column, in which each entry stores the parameter value for the compressed data of the corresponding row in the table.
      Returns:
      The array that contains the data for each compressed row.
      Since:
      1.18
      See Also:

    • column

      @Deprecated default Object column()
      Deprecated.
      Provided for back compatibility only. Use getColumnData() instead.
      Returns:
      The array that contains the data for each compressed row.

    • initializedColumn

      @Deprecated default Object initializedColumn()
      Deprecated.
      Provided for back compatibility only. Use getColumnData() instead.
      Returns:
      The array that contains the data for each compressed row.

    • setColumnData

      void setColumnData(Object column, int size)
      Sets new parameter data for each compressed row to be stored along as a separate parameter column in the compressed table. To discard prior column data with no replacement, you can call this as setColumnData(null, 0).
      Parameters:
      column - The array that contains the data for each compressed row. If not null the size parameter is ignored, and the size of the array is used instead.
      size - The number of compressed rows in the table, if the column argument is null. If size is zero or negative, any prior column data will be discarded and null will be set.
      See Also:

    • column

      @Deprecated default void column(Object column, int size)
      Deprecated.
      Provided for back compatibility only. Use setColumnData(Object, int) instead.
      Parameters:
      column - The array that contains the data for each compressed row. If not null the size parameter is ignored, and the size of the array is used instead.
      size - The number of compressed rows in the table, if the column argument is null

    • getValueFromColumn

      void getValueFromColumn(int index)
      Updates the associated compression options to use the parameter value defined to the compressed tile of the specified index.
      Parameters:
      index - the tile index, a.k.a. row index in the compressed data table.
      See Also:

    • setValueInColumn

      void setValueInColumn(int index)
      Stores the current parameter value of the associated compression options for the tile of the specified index.
      Parameters:
      index - the tile index, a.k.a. row index in the compressed data table.
      See Also:

    • setValueFromColumn

      @Deprecated default void setValueFromColumn(int index)
      Deprecated.
      Provided for back compatibility only. Use setValueInColumn(int) instead.
      Parameters:
      index - the tile index, a.k.a. row index in the compressed data table.