Package adams.doc.latex.generator

Class Table

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, CodeGenerator, adams.flow.control.StorageUser, adams.flow.core.FlowContextHandler, Serializable
    public class Table
extends AbstractCodeGenerator
implements adams.flow.control.StorageUser
    Inserts the spreadsheet obtained from storage as table. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -skip <boolean> (property: skip)
    If enabled, the code generation gets skipped.
    default: false
 
    -no-var-expansion <boolean> (property: noVariableExpansion)
    If enabled, variable expansion gets skipped.
    default: false
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name for the lookup table in the internal storage.
    default: table
 
    -missing <java.lang.String> (property: missingValue)
    The placeholder for missing values.
    default: 
 
    -locale <java.util.Locale> (property: locale)
    The locale to use for formatting the numbers.
    default: Default
 
    -number-format <java.lang.String> (property: numberFormat)
    The format for the numbers (see java.text.DecimalFormat), use empty string 
    for default 'double' output.
    default:
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected adams.flow.control.StorageName m_StorageName
        the storage name of the spreadsheet to insert.

      • m_MissingValue

        protected String m_MissingValue
        The placeholder for missing values.

      • m_Locale

        protected Locale m_Locale
        the locale to use.

      • m_NumberFormat

        protected String m_NumberFormat
        The format for the numbers.

    • Constructor Detail

      • Table

        public Table()

    • 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 AbstractCodeGenerator

      • setStorageName

        public void setStorageName​(adams.flow.control.StorageName value)
        Sets the name for the lookup table in the internal storage.
        Parameters:
        value - the name

      • getStorageName

        public adams.flow.control.StorageName getStorageName()
        Returns the name for the lookup table in the internal storage.
        Returns:
        the name

      • storageNameTipText

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

      • getDefaultMissingValue

        protected String getDefaultMissingValue()
        Returns the default missing value.
        Returns:
        the default for missing values

      • setMissingValue

        public void setMissingValue​(String value)
        Sets the placeholder for missing values.
        Parameters:
        value - the placeholder

      • getMissingValue

        public String getMissingValue()
        Returns the current placeholder for missing values.
        Returns:
        the placeholder

      • missingValueTipText

        public String missingValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setLocale

        public void setLocale​(Locale value)
        Sets the locale to use.
        Parameters:
        value - the locale

      • getLocale

        public Locale getLocale()
        Returns the locale in use.
        Returns:
        the locale

      • localeTipText

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

      • getDefaultNumberFormat

        protected String getDefaultNumberFormat()
        Returns the default number format.
        Returns:
        the default format

      • setNumberFormat

        public void setNumberFormat​(String value)
        Sets the number format.
        Parameters:
        value - the format

      • getNumberFormat

        public String getNumberFormat()
        Returns the number format.
        Returns:
        the format

      • numberFormatTipText

        public String numberFormatTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • getQuickInfo

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

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface adams.flow.control.StorageUser
        Returns:
        true if storage items are used