Package adams.flow.standalone

Class LatexSetup

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, Serializable, Comparable
    public class LatexSetup
extends adams.flow.standalone.AbstractStandalone
    Allows to configure LaTex and override the system-wide settings. 

    -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: LatexSetup
 
    -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 execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -binaries-dir <adams.core.io.PlaceholderDirectory> (property: binariesDir)
    The directory containing the LaTeX binaries.
    default: /usr/local/texlive/2016/bin/x86_64-linux
 
    -executable <java.lang.String> (property: executable)
    The executable to use (no path).
    default: pdflatex
 
    -executable-options <java.lang.String> (property: executableOptions)
    The options for the executable to use.
    default: -halt-on-error
 
    -bibtex <java.lang.String> (property: bibtex)
    The bibtex executable to use (no path).
    default: pdflatex
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Bibtex
      the bibtex executable.
      protected adams.core.io.PlaceholderDirectory m_BinariesDir
      the path to the binaries.
      protected String m_Executable
      the executable.
      protected String m_ExecutableOptions
      the executable options.

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      LatexSetup()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String bibtexPath()
      Returns the full path of the bibtex executable.
      String bibtexTipText()
      Returns the tip text for this property.
      String binariesDirTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String executableOptionsTipText()
      Returns the tip text for this property.
      String executablePath()
      Returns the full path of the executable.
      String executablePath​(String exec)
      Returns the full path of the executable.
      String executableTipText()
      Returns the tip text for this property.
      String getBibtex()
      Returns the bibtex executable to use (no path).
      adams.core.io.PlaceholderDirectory getBinariesDir()
      Returns the binaries directory to use.
      String getExecutable()
      Returns the executable to use (no path).
      String getExecutableOptions()
      Returns the options for the executable to use.
      String globalInfo()
      Returns a string describing the object.
      void setBibtex​(String value)
      Sets the bibtex executable to use (no path).
      void setBinariesDir​(adams.core.io.PlaceholderDirectory value)
      Sets the binaries directory to use.
      void setExecutable​(String value)
      Sets the executable to use (no path).
      void setExecutableOptions​(String value)
      Sets the options for the executable to use.

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

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

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

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        toCommandLine

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

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

        cleanUpOptions, getOptionManager

    • Field Detail

      • m_BinariesDir

        protected adams.core.io.PlaceholderDirectory m_BinariesDir
        the path to the binaries.

      • m_Executable

        protected String m_Executable
        the executable.

      • m_ExecutableOptions

        protected String m_ExecutableOptions
        the executable options.

      • m_Bibtex

        protected String m_Bibtex
        the bibtex executable.

    • Constructor Detail

      • LatexSetup

        public LatexSetup()

    • 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.flow.core.AbstractActor

      • setBinariesDir

        public void setBinariesDir​(adams.core.io.PlaceholderDirectory value)
        Sets the binaries directory to use.
        Parameters:
        value - the dir

      • getBinariesDir

        public adams.core.io.PlaceholderDirectory getBinariesDir()
        Returns the binaries directory to use.
        Returns:
        the dir

      • binariesDirTipText

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

      • setExecutable

        public void setExecutable​(String value)
        Sets the executable to use (no path).
        Parameters:
        value - the executable

      • getExecutable

        public String getExecutable()
        Returns the executable to use (no path).
        Returns:
        the executable

      • executableTipText

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

      • setExecutableOptions

        public void setExecutableOptions​(String value)
        Sets the options for the executable to use.
        Parameters:
        value - the options

      • getExecutableOptions

        public String getExecutableOptions()
        Returns the options for the executable to use.
        Returns:
        the options

      • executableOptionsTipText

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

      • setBibtex

        public void setBibtex​(String value)
        Sets the bibtex executable to use (no path).
        Parameters:
        value - the executable

      • getBibtex

        public String getBibtex()
        Returns the bibtex executable to use (no path).
        Returns:
        the executable

      • bibtexTipText

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

      • executablePath

        public String executablePath​(String exec)
        Returns the full path of the executable.
        Parameters:
        exec - the executable (no path)
        Returns:
        the full path

      • executablePath

        public String executablePath()
        Returns the full path of the executable.
        Returns:
        the full path

      • bibtexPath

        public String bibtexPath()
        Returns the full path of the bibtex executable.
        Returns:
        the full path

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        always null