Package adams.flow.transformer

Class SpreadSheetCommonIDs

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetCommonIDs
extends AbstractTransformer
    Extracts the common IDs from two or more spreadsheets.
    Matching sense can be inverted, i.e., the IDs not in common are output.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet[]
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetCommonIDs
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -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
 
    -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

      • SpreadSheetCommonIDs

        public SpreadSheetCommonIDs()

    • 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.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message