Class AbstractObjectFinder

    • Field Detail

      • m_Prefix

        protected String m_Prefix
        the prefix of the objects in the report.
      • m_ResetIndicesIfNecessary

        protected boolean m_ResetIndicesIfNecessary
        whether to reset indices if necessary.
      • m_Lenient

        protected boolean m_Lenient
        whether to be lenient with indices.
      • m_Quiet

        protected boolean m_Quiet
        whether to suppress warning messages.
    • Constructor Detail

      • AbstractObjectFinder

        public AbstractObjectFinder()
    • Method Detail

      • setResetIndicesIfNecessary

        public void setResetIndicesIfNecessary​(boolean value)
        Sets whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.
        Specified by:
        setResetIndicesIfNecessary in interface ObjectFinder
        Parameters:
        value - true if to reset
      • getResetIndicesIfNecessary

        public boolean getResetIndicesIfNecessary()
        Returns whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.
        Specified by:
        getResetIndicesIfNecessary in interface ObjectFinder
        Returns:
        true if to reset
      • resetIndicesIfNecessaryTipText

        public String resetIndicesIfNecessaryTipText()
        Returns the tip text for this property.
        Specified by:
        resetIndicesIfNecessaryTipText in interface ObjectFinder
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setLenient

        public void setLenient​(boolean value)
        Sets whether to suppress error if -1 indices found.
        Specified by:
        setLenient in interface LenientModeSupporter
        Parameters:
        value - true if to suppress
      • getLenient

        public boolean getLenient()
        Returns whether to suppress error if -1 indices found.
        Specified by:
        getLenient in interface LenientModeSupporter
        Returns:
        true if to suppress
      • lenientTipText

        public String lenientTipText()
        Returns the tip text for this property.
        Specified by:
        lenientTipText in interface LenientModeSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setQuiet

        public void setQuiet​(boolean value)
        Sets whether to suppress warning messages if -1 indices found.
        Parameters:
        value - true if to suppress
      • getQuiet

        public boolean getQuiet()
        Returns whether to suppress warning messages if -1 indices found.
        Returns:
        true if to suppress
      • quietTipText

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

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string
      • check

        protected String check​(LocatedObjects objects)
        Hook method for performing checks.

        Default implementation returns null.
        Parameters:
        objects - the list of objects to check
        Returns:
        null if successful check, otherwise error message
      • doFind

        protected abstract int[] doFind​(LocatedObjects objects)
        Performs the actual finding of the objects in the list.
        Parameters:
        objects - the list of objects to process
        Returns:
        the indices
      • find

        public int[] find​(LocatedObjects objects)
        Finds the objects in the list of objects.
        Specified by:
        find in interface ObjectFinder
        Parameters:
        objects - the list of objects to process
        Returns:
        the indices
      • find

        public int[] find​(Report report)
        Finds the objects in the report.
        Specified by:
        find in interface ObjectFinder
        Parameters:
        report - the report to process
        Returns:
        the indices
      • findObjects

        public LocatedObjects findObjects​(Report report)
        Finds the objects in the report.
        Specified by:
        findObjects in interface ObjectFinder
        Parameters:
        report - the report to process
        Returns:
        the indices
      • filter

        public Report filter​(Report report)
        Filters the objects in the report.
        Specified by:
        filter in interface ObjectFinder
        Parameters:
        report - the report to process
        Returns:
        the filtered report