Package adams.flow.source

Class NewLatexDocument

  • 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, adams.flow.core.OutputProducer, Serializable, Comparable
    public class NewLatexDocument
extends adams.flow.source.AbstractSimpleSource
    Creates a new LaTeX document.

    Input/output:
    - generates:
       java.lang.StringBuilder


    -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: NewLatexDocument
 
    -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
 
    -prolog <adams.core.base.BaseText> (property: prolog)
    The (optional) prolog to insert as comments before the document starts.
    default: 
 
    -document-class <java.lang.String> (property: documentClass)
    The document class to use for the document.
    default: article
 
    -document-class-options <java.lang.String> (property: documentClassOptions)
    The options (if any) for the document class.
    default: a4paper
 
    -additional-statements <adams.core.base.BaseText> (property: additionalStatements)
    The additional statements (eg include or usepackage) to insert.
    default:
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseText m_AdditionalStatements
      the additional statements to include.
      protected String m_DocumentClass
      the document class.
      protected String m_DocumentClassOptions
      optional parameters for the document class.
      protected adams.core.base.BaseText m_Prolog
      the optional prolog (inserted as comments).

      • Fields inherited from class adams.flow.source.AbstractSimpleSource

        m_OutputToken

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String additionalStatementsTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      String documentClassOptionsTipText()
      Returns the tip text for this property.
      String documentClassTipText()
      Returns the tip text for this property.
      protected String doExecute()
      Executes the flow item.
      Class[] generates()
      Returns the class of objects that it generates.
      adams.core.base.BaseText getAdditionalStatements()
      Returns the additional statements to insert.
      String getDocumentClass()
      Returns the document class to use.
      String getDocumentClassOptions()
      Returns the options to use for the document class.
      adams.core.base.BaseText getProlog()
      Returns the prolog to insert (as comments).
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String prologTipText()
      Returns the tip text for this property.
      void setAdditionalStatements​(adams.core.base.BaseText value)
      Sets the additional statements to insert.
      void setDocumentClass​(String value)
      Sets the document class to use.
      void setDocumentClassOptions​(String value)
      Sets the options to use for the document class.
      void setProlog​(adams.core.base.BaseText value)
      Sets the prolog to insert (as comments).

      • Methods inherited from class adams.flow.source.AbstractSimpleSource

        hasPendingOutput, initialize, output, reset

      • 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, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, 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

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • 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

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Prolog

        protected adams.core.base.BaseText m_Prolog
        the optional prolog (inserted as comments).

      • m_DocumentClass

        protected String m_DocumentClass
        the document class.

      • m_DocumentClassOptions

        protected String m_DocumentClassOptions
        optional parameters for the document class.

      • m_AdditionalStatements

        protected adams.core.base.BaseText m_AdditionalStatements
        the additional statements to include.

    • Constructor Detail

      • NewLatexDocument

        public NewLatexDocument()

    • 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

      • setProlog

        public void setProlog​(adams.core.base.BaseText value)
        Sets the prolog to insert (as comments).
        Parameters:
        value - the prolog

      • getProlog

        public adams.core.base.BaseText getProlog()
        Returns the prolog to insert (as comments).
        Returns:
        the prolog

      • prologTipText

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

      • setDocumentClass

        public void setDocumentClass​(String value)
        Sets the document class to use.
        Parameters:
        value - the class

      • getDocumentClass

        public String getDocumentClass()
        Returns the document class to use.
        Returns:
        the class

      • documentClassTipText

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

      • setDocumentClassOptions

        public void setDocumentClassOptions​(String value)
        Sets the options to use for the document class.
        Parameters:
        value - the options

      • getDocumentClassOptions

        public String getDocumentClassOptions()
        Returns the options to use for the document class.
        Returns:
        the options

      • documentClassOptionsTipText

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

      • setAdditionalStatements

        public void setAdditionalStatements​(adams.core.base.BaseText value)
        Sets the additional statements to insert.
        Parameters:
        value - the statements

      • getAdditionalStatements

        public adams.core.base.BaseText getAdditionalStatements()
        Returns the additional statements to insert.
        Returns:
        the statements

      • additionalStatementsTipText

        public String additionalStatementsTipText()
        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 actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • 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 adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message