Package adams.flow.processor

Class ListRequiredLatexPackages

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.flow.processor.ActorProcessor>, adams.core.SizeOfHandler, adams.flow.processor.ActorProcessor, adams.flow.processor.GraphicalOutputProducingProcessor, adams.flow.processor.ListingProcessor, Serializable, Comparable<adams.flow.processor.ActorProcessor>
    public class ListRequiredLatexPackages
extends adams.flow.processor.AbstractListingProcessor
    Generates a list of all the packages required by the adams.doc.latex.generator.CodeGenerator-derived LaTeX generators. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_GenerateUsePackageStatements
      whether to generate latex code.

      • Fields inherited from class adams.flow.processor.AbstractListingProcessor

        m_List

      • Fields inherited from class adams.flow.processor.AbstractActorProcessor

        m_Errors

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected boolean generatesMultipleItems()
      Returns whether the list generates a string array per object or not.
      String generateUsePackageStatementsTipText()
      Returns the tip text for this property.
      boolean getGenerateUsePackageStatements()
      Returns whether to generate latex code.
      protected String getHeader()
      Returns the header to use in the dialog, i.e., the one-liner that explains the output.
      String getTitle()
      Returns the title for the dialog.
      String globalInfo()
      Returns a string describing the object.
      protected boolean isSortedList()
      Returns whether the list should be sorted.
      protected boolean isUniqueList()
      Returns whether the list should not contain any duplicates.
      protected boolean isValid​(adams.core.option.AbstractOption option, Object obj, adams.core.option.OptionTraversalPath path)
      Checks whether the object is valid and should be added to the list.
      protected String[] objectToStrings​(adams.core.option.AbstractOption option, Object obj, adams.core.option.OptionTraversalPath path)
      Returns the string representation of the object that is added to the list.
      void setGenerateUsePackageStatements​(boolean value)
      Sets whether to generate latex code.

      • Methods inherited from class adams.flow.processor.AbstractListingProcessor

        finalizeList, getDefaultSize, getGraphicalOutput, getList, hasGraphicalOutput, initializeList, objectToString, process, processActor

      • Methods inherited from class adams.flow.processor.AbstractActorProcessor

        addError, addError, checkData, compareTo, equals, getErrors, hasErrors, initialize, process, reset, shallowCopy, shallowCopy

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.flow.processor.ActorProcessor

        compareTo, getErrors, hasErrors, process, shallowCopy, shallowCopy

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_GenerateUsePackageStatements

        protected boolean m_GenerateUsePackageStatements
        whether to generate latex code.

    • Constructor Detail

      • ListRequiredLatexPackages

        public ListRequiredLatexPackages()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setGenerateUsePackageStatements

        public void setGenerateUsePackageStatements​(boolean value)
        Sets whether to generate latex code.
        Parameters:
        value - true if to generate latex

      • getGenerateUsePackageStatements

        public boolean getGenerateUsePackageStatements()
        Returns whether to generate latex code.
        Returns:
        true if to generate latex

      • generateUsePackageStatementsTipText

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

      • getTitle

        public String getTitle()
        Returns the title for the dialog.
        Returns:
        the title

      • isValid

        protected boolean isValid​(adams.core.option.AbstractOption option,
                          Object obj,
                          adams.core.option.OptionTraversalPath path)
        Checks whether the object is valid and should be added to the list.
        Specified by:
        isValid in class adams.flow.processor.AbstractListingProcessor
        Parameters:
        option - the current option
        obj - the object to check
        path - the traversal path of properties
        Returns:
        true if valid

      • objectToStrings

        protected String[] objectToStrings​(adams.core.option.AbstractOption option,
                                   Object obj,
                                   adams.core.option.OptionTraversalPath path)
        Returns the string representation of the object that is added to the list.
        Overrides:
        objectToStrings in class adams.flow.processor.AbstractListingProcessor
        Parameters:
        option - the current option
        obj - the object to turn into a string
        path - the traversal path of properties
        Returns:
        the string representation, null if to ignore the item

      • generatesMultipleItems

        protected boolean generatesMultipleItems()
        Returns whether the list generates a string array per object or not.
        Overrides:
        generatesMultipleItems in class adams.flow.processor.AbstractListingProcessor
        Returns:
        true if multiple items get generated
        See Also:
        AbstractListingProcessor.objectToString(AbstractOption, Object, OptionTraversalPath), objectToStrings(AbstractOption, Object, OptionTraversalPath)

      • isSortedList

        protected boolean isSortedList()
        Returns whether the list should be sorted.
        Specified by:
        isSortedList in class adams.flow.processor.AbstractListingProcessor
        Returns:
        true if the list should get sorted

      • isUniqueList

        protected boolean isUniqueList()
        Returns whether the list should not contain any duplicates.
        Specified by:
        isUniqueList in class adams.flow.processor.AbstractListingProcessor
        Returns:
        true if the list contains no duplicates

      • getHeader

        protected String getHeader()
        Returns the header to use in the dialog, i.e., the one-liner that explains the output.
        Specified by:
        getHeader in class adams.flow.processor.AbstractListingProcessor
        Returns:
        the header, null if no header available