Package adams.data.conversion

Class SpreadSheetAddFormulaColumn

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable
    public class SpreadSheetAddFormulaColumn
extends AbstractInPlaceSpreadSheetConversion
    Adds a column with a user-supploed formula for the specified rows. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -header <java.lang.String> (property: header)
    The title of the formula column.
    default: Sum
 
    -formula <adams.parser.SpreadSheetFormulaText> (property: formula)
    The formula to add (incl '='); use '@' as placeholder for the current row
    and '#' for the last column.
    default: =sum(A@:#@)
 
    -rows <adams.core.Range> (property: rows)
    The range of rows to add the formula for.
    default: first-last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -expand-variables <boolean> (property: expandVariables)
    If enabled, any variables in the formula get expanded first before adding
    it to the spreadsheet.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • PLACEHOLDER_CURRENT_ROW

        public static final String PLACEHOLDER_CURRENT_ROW
        the placeholder for the row.
        See Also:
        Constant Field Values

      • PLACEHOLDER_LAST_COL

        public static final String PLACEHOLDER_LAST_COL
        the placeholder for the last column.
        See Also:
        Constant Field Values

      • PLACEHOLDER_LAST_ROW

        public static final String PLACEHOLDER_LAST_ROW
        the placeholder for the last row.
        See Also:
        Constant Field Values

      • m_Header

        protected String m_Header
        the column header.

      • m_Rows

        protected Range m_Rows
        the rows to add the formula to.

      • m_ExpandVariables

        protected boolean m_ExpandVariables
        whether to expand variables.

    • Constructor Detail

      • SpreadSheetAddFormulaColumn

        public SpreadSheetAddFormulaColumn()

    • Method Detail

      • setHeader

        public void setHeader​(String value)
        Sets the column header to use.
        Parameters:
        value - the header

      • getHeader

        public String getHeader()
        Returns the column header in use.
        Returns:
        the header

      • headerTipText

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

      • setFormula

        public void setFormula​(SpreadSheetFormulaText value)
        Sets the formula to use.
        Parameters:
        value - the formula (incl. "=")

      • getFormula

        public SpreadSheetFormulaText getFormula()
        Returns the formula in use.
        Returns:
        the formula (incl. "=")

      • formulaTipText

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

      • setRows

        public void setRows​(Range value)
        Sets the range of rows to add the sum for.
        Parameters:
        value - the range

      • getRows

        public Range getRows()
        Returns the range of rows to add the sum for.
        Returns:
        true range

      • rowsTipText

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

      • setExpandVariables

        public void setExpandVariables​(boolean value)
        Sets whether to expand any variable first before adding the formula to the spreadsheet.
        Parameters:
        value - true if to expand first

      • getExpandVariables

        public boolean getExpandVariables()
        Returns whether to expand any variable first before adding the formula to the spreadsheet.
        Returns:
        true if to expand first

      • expandVariablesTipText

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