Class MaskSpec


  • @Equality
    public class MaskSpec
    extends java.lang.Object
    Characterises information about a data inclusion mask. It aggregates a table and a maskId, and provides the capability of reading the corresponding inclusion data from a RowSequence.
    Since:
    6 Jan 2020
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      MaskSpec​(DataSpec dataSpec)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.lang.String getMaskId()
      Returns the unique mask identifier string associated with this spec.
      uk.ac.starlink.table.StarTable getTable()
      Returns the table to which this mask belongs.
      int hashCode()  
      boolean readFlag​(uk.ac.starlink.table.RowSequence rseq, long irow)
      Reads inclusion flag from a row sequence.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • MaskSpec

        public MaskSpec​(DataSpec dataSpec)
        Constructor.
        Parameters:
        dataSpec - specification from which the mask information is taken
    • Method Detail

      • getTable

        public uk.ac.starlink.table.StarTable getTable()
        Returns the table to which this mask belongs.
        Returns:
        table
      • getMaskId

        public java.lang.String getMaskId()
        Returns the unique mask identifier string associated with this spec.
        Returns:
        mask ID
      • readFlag

        public boolean readFlag​(uk.ac.starlink.table.RowSequence rseq,
                                long irow)
                         throws java.io.IOException
        Reads inclusion flag from a row sequence.
        Parameters:
        rseq - row sequence of this data spec's table
        irow - row index
        Returns:
        inclusion mask for current row
        Throws:
        java.io.IOException
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object