Package adams.flow.transformer.multispreadsheetoperation

Class CommonIDs

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable
    public class CommonIDs
extends AbstractMultiSpreadSheetOperation<SpreadSheet>
    Extracts the common IDs from two or more spreadsheets.
    Matching sense can be inverted, i.e., the IDs not in common are output. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -index <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: index)
    The index of the column with the IDs in the spreadsheet.
    default: first
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -invert <boolean> (property: invert)
    Whether to invert the matching sense and return the IDs 'not' in common.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Invert

        protected boolean m_Invert
        whether to invert the matching (= return the IDs not in common).

    • Constructor Detail

      • CommonIDs

        public CommonIDs()

    • Method Detail

      • setIndex

        public void setIndex​(SpreadSheetColumnIndex value)
        Sets the index of the column in the spreadsheet.
        Parameters:
        value - the index

      • getIndex

        public SpreadSheetColumnIndex getIndex()
        Returns the index of the column in the spreadsheet.
        Returns:
        the index

      • indexTipText

        public String indexTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setInvert

        public void setInvert​(boolean value)
        Sets whether to invert the matchin, i.e., return IDs not in common.
        Parameters:
        value - true if to invert matching

      • getInvert

        public boolean getInvert()
        Returns whether to invert the matchin, i.e., return IDs not in common.
        Returns:
        true if to invert matching

      • invertTipText

        public String invertTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.