Class SpreadSheetDoubleColumnToString

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable

    public class SpreadSheetDoubleColumnToString
    extends AbstractSpreadSheetColumnConverter
    Converts the specified spreadsheet double column to string.

    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to 
        the console (0 = off).
        default: 0
        minimum: 0
     
    -column <adams.core.Index> (property: column)
        The double column to convert to string; An index is a number starting with 
        1; the following placeholders can be used as well: first, second, third, 
        last_2, last_1, last
        default: first
     
    -num-decimals <int> (property: numDecimals)
        The number of decimals for numeric values to use; -1 uses Java's Double.toString
        () method.
        default: -1
        minimum: -1
     
    -fixed-decimals (property: fixedDecimals)
        If enabled and 'num-decimals' is specified, a fixed number of decimals will 
        get output (incl. trailing zeroes), otherwise up-to 'num-decimals'.
     
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_NumDecimals

        protected int m_NumDecimals
        the number of decimals to in the output.
      • m_FixedDecimals

        protected boolean m_FixedDecimals
        whether to use a fixed number of decimals.
    • Constructor Detail

      • SpreadSheetDoubleColumnToString

        public SpreadSheetDoubleColumnToString()
    • Method Detail

      • setNumDecimals

        public void setNumDecimals​(int value)
        Sets the number of decimals for numbers in tables.
        Parameters:
        value - the number of decimals
      • getNumDecimals

        public int getNumDecimals()
        Returns the number of decimals for numbers in tables.
        Returns:
        the number of decimals
      • numDecimalsTipText

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

        public void setFixedDecimals​(boolean value)
        Sets whether to always use a fixed number of decimals, incl trailing zeroes.
        Parameters:
        value - true to use fixed number
      • getFixedDecimals

        public boolean getFixedDecimals()
        Returns whether to always use a fixed number of decimals, incl trailing zeroes.
        Returns:
        true if fixed number used
      • fixedDecimalsTipText

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