Class ProgressLineStarTable

java.lang.Object
uk.ac.starlink.table.WrapperStarTable
uk.ac.starlink.table.ProgressLineStarTable
All Implemented Interfaces:
Closeable, AutoCloseable, StarTable

public class ProgressLineStarTable extends WrapperStarTable
A WrapperStarTable which behaves the same as its base, except that any RowSequence taken out on it will display an ASCII progress line on a terminal describing how far through the table it's got. It might decide not to do this if the table is very short.
Author:
Mark Taylor (Starlink)
  • Constructor Details

    • ProgressLineStarTable

      public ProgressLineStarTable(StarTable baseTable, PrintStream out)
      Constructs a new ProgressLineStarTable.
      Parameters:
      baseTable - the base table
      out - stream on which progress will be written - this should preferably be terminal-like, since it's going to have things like carriage-returns ('\r') written to it
  • Method Details

    • getRowSequence

      public RowSequence getRowSequence() throws IOException
      Description copied from interface: StarTable
      Returns an object which can iterate over all the rows in the table sequentially. Each such returned object is safe for use within a single thread, but not in general from multiple threads concurrently.
      Specified by:
      getRowSequence in interface StarTable
      Overrides:
      getRowSequence in class WrapperStarTable
      Returns:
      new RowSequence
      Throws:
      IOException - if there is an error providing access
    • getRowSplittable

      public RowSplittable getRowSplittable() throws IOException
      Description copied from interface: StarTable
      Returns an object which can iterate over all the rows in the table, but which may also be requested to split recursively for potentially parallel processing.

      The return value must be non-null, and may provide splitting arrangements specially appropriate for the implementation. If this table 'wraps' an upstream table, it is usually best to base the implementation on calls to the the upstream getRowSplittable method, so that upstream policy about how to divide up the table is respected. However, implementations without special requirements may return Tables.getDefaultRowSplittable(this).

      Specified by:
      getRowSplittable in interface StarTable
      Overrides:
      getRowSplittable in class WrapperStarTable
      Returns:
      new RowSplittable
      Throws:
      IOException
      See Also: