package nom.tam.image.compression.bintable;
   
   /*
    * #%L
    * nom.tam FITS library
    * %%
    * Copyright (C) 1996 - 2024 nom-tam-fits
    * %%
    * This is free and unencumbered software released into the public domain.
   *
   * Anyone is free to copy, modify, publish, use, compile, sell, or
   * distribute this software, either in source code form or as a compiled
   * binary, for any purpose, commercial or non-commercial, and by any
   * means.
   *
   * In jurisdictions that recognize copyright laws, the author or authors
   * of this software dedicate any and all copyright interest in the
   * software to the public domain. We make this dedication for the benefit
   * of the public at large and to the detriment of our heirs and
   * successors. We intend this dedication to be an overt act of
   * relinquishment in perpetuity of all present and future rights to this
   * software under copyright law.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
   * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
   * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
   * OTHER DEALINGS IN THE SOFTWARE.
   * #L%
   */
  
  import java.nio.Buffer;
  import java.util.concurrent.ExecutorService;
  import java.util.concurrent.Future;
  
  import nom.tam.fits.Header;
  import nom.tam.fits.HeaderCardException;
  import nom.tam.fits.compression.algorithm.api.ICompressorControl;
  import nom.tam.fits.compression.provider.CompressorProvider;
  import nom.tam.fits.header.Compression;
  import nom.tam.util.ColumnTable;
  import nom.tam.util.type.ElementType;
  
  /**
   * (<i>for internal use</i>) A table 'tile' representing a set of consecutive table rows that are compressed together as
   * a block.
   */
  @SuppressWarnings("javadoc")
  public abstract class BinaryTableTile implements Runnable {
  
      protected final ColumnTable<?> data;
  
      /**
       * start row.
       */
      protected final int rowStart;
  
      /**
       * last row (exclusive)
       */
      protected final int rowEnd;
  
      protected final int column;
  
      protected String compressionAlgorithm;
  
      protected final ElementType<Buffer> type;
  
      protected final int length;
  
      protected final int tileIndex; /// 0-based tile index
  
      private Future<?> future;
  
      public BinaryTableTile(ColumnTable<?> data, BinaryTableTileDescription description) {
          this.data = data;
          rowStart = description.getRowStart();
          rowEnd = description.getRowEnd();
          column = description.getColumn();
          tileIndex = description.getTileIndex() - 1;
          compressionAlgorithm = description.getCompressionAlgorithm();
          type = ElementType.forClass(data.getElementClass(column));
          length = (rowEnd - rowStart) * data.getElementSize(column);
      }
  
      public void execute(ExecutorService threadPool) {
          future = threadPool.submit(this);
      }
  
      /**
       * @deprecated (<i> for internal use</i>) No longer used.
       */
      public void fillHeader(Header header) throws HeaderCardException {
          header.card(Compression.ZCTYPn.n(column + 1)).value(compressionAlgorithm);
      }
  
      /**
      * Returns the zero-based tile index.
      * 
      * @return the zero-based tile index (a.k.a. Java index).
      */
     public int getTileIndex() {
         return tileIndex;
     }
 
     public void waitForResult() {
         try {
             future.get();
         } catch (Exception e) {
             throw new IllegalStateException(
                     "could not process tile " + (tileIndex + 1) + ", column " + column + ": " + e.getMessage(), e);
         }
     }
 
     protected ICompressorControl getCompressorControl() {
         return CompressorProvider.findCompressorControl(null, compressionAlgorithm, type.primitiveClass());
     }
 
     protected ICompressorControl getCompressorControl(Class<?> dataType) {
         return CompressorProvider.findCompressorControl(null, compressionAlgorithm, dataType);
     }
 
     protected ICompressorControl getGZipCompressorControl() {
         return CompressorProvider.findCompressorControl(null, Compression.ZCMPTYPE_GZIP_1, byte.class);
     }
 
     protected int getUncompressedSizeInBytes() {
         return length * type.size();
     }
 }