Class AbstractPlotProcessor

    • Field Detail

      • m_PlotNameSuffix

        protected String m_PlotNameSuffix
        the suffix for the plotname to use (becomes overlay if none provided).
      • m_LastError

        protected String m_LastError
        for storing an error message.
    • Constructor Detail

      • AbstractPlotProcessor

        public AbstractPlotProcessor()
    • Method Detail

      • plotNameSuffixTipText

        public String plotNameSuffixTipText()
        Returns the tip text for this property.
        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.

        Default implementation returns null.
        Specified by:
        getQuickInfo in interface QuickInfoSupporter
        null if no info available, otherwise short string
      • check

        protected String check​(SequencePlotterContainer cont)
        Checks the current container.

        Default implementation only checks whether a container was provided at all.
        cont - the container to check
        null if everything OK, otherwise error message
      • getPlotName

        protected String getPlotName​(SequencePlotterContainer cont)
        Returns the plot name. Takes a potentially set suffix into account.
        cont - the container to extract the name from
        the plot name
      • preProcess

        protected void preProcess​(SequencePlotterContainer cont)
        Hook method before processing the plot container.
        cont - the container to process
      • doProcess

        protected abstract List<SequencePlotterContainer> doProcess​(SequencePlotterContainer cont)
        Processes the provided container. Generates new containers if applicable.
        cont - the container to process
        null if no new containers were produced
      • isValid

        protected boolean isValid​(Comparable value)
        Checks wheteher value is valid.

        Default implementation makes sure that doubles aren't NaN.
        value - the value to check
        true if valid
      • hasLastError

        public boolean hasLastError()
        Returns whether the last processing generated an error message.
        Specified by:
        hasLastError in interface ErrorProvider
        true if an error message was generated
      • getLastError

        public String getLastError()
        Returns the error message from the last processing (if any).
        Specified by:
        getLastError in interface ErrorProvider
        the last error message, null if none occurred
      • cleanUp

        public void cleanUp()
        Cleans up data structures, frees up memory.
        Specified by:
        cleanUp in interface CleanUpHandler