adams.data.conversion
Class SpreadSheetAddFormulaRow

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.AbstractSpreadSheetConversion
                  adams.data.conversion.AbstractInPlaceSpreadSheetConversion
                      adams.data.conversion.SpreadSheetAddFormulaRow

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable

public class SpreadSheetAddFormulaRow
extends AbstractInPlaceSpreadSheetConversion

Adds a row with a user-supplied formula for the specified columns.

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
 

-no-copy (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
 

-formula <java.lang.String> (property: formula)
    The formula to add (incl '='); use '@' as placeholder for the current column.
    default: =sum(@1:@10)
 

-columns <adams.core.Range> (property: columns)
    The range of columns to add the formula for; 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
    default: first-last
 

Version:

$Revision: 6866 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetColumnRange	m_Columns the columns to add the sum to.
protected String	m_Formula the formula to add.
static String	PLACEHOLDER_COLUMN the placeholder for the column.
static String	PLACEHOLDER_LAST_ROW the placeholder for the last row.

Fields inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion

m_NoCopy

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetAddFormulaRow()

Method Summary

String	columnsTipText() Returns the tip text for this property.
protected SpreadSheet	convert(SpreadSheet input) Generates the new spreadsheet from the input.
void	defineOptions() Adds options to the internal list of options.
String	formulaTipText() Returns the tip text for this property.
SpreadSheetColumnRange	getColumns() Returns the range of columns to add the sum for.
String	getFormula() Returns the formula in use.
String	globalInfo() Returns a string describing the object.
void	setColumns(SpreadSheetColumnRange value) Sets the range of columns to add the sum for.
void	setFormula(String value) Sets the formula to use.

Methods inherited from class adams.data.conversion.AbstractInPlaceSpreadSheetConversion

getNoCopy, noCopyTipText, setNoCopy

Methods inherited from class adams.data.conversion.AbstractSpreadSheetConversion

accepts, doConvert, generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getInput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PLACEHOLDER_COLUMN

public static final String PLACEHOLDER_COLUMN

the placeholder for the 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_Formula

protected String m_Formula

the formula to add.

m_Columns

protected SpreadSheetColumnRange m_Columns

the columns to add the sum to.

Constructor Detail

SpreadSheetAddFormulaRow

public SpreadSheetAddFormulaRow()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractInPlaceSpreadSheetConversion

setFormula

public void setFormula(String value)

Sets the formula to use.

Parameters:

value - the formula (incl. "=")

getFormula

public String 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.

setColumns

public void setColumns(SpreadSheetColumnRange value)

Sets the range of columns to add the sum for.

Parameters:

value - the range

getColumns

public SpreadSheetColumnRange getColumns()

Returns the range of columns to add the sum for.

Returns:

true range

columnsTipText

public String columnsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

convert

protected SpreadSheet convert(SpreadSheet input)
                       throws Exception

Generates the new spreadsheet from the input.

Specified by:

convert in class AbstractSpreadSheetConversion

Parameters:

input - the incoming spreadsheet

Returns:

the generated spreadsheet

Throws:

Exception - if conversion fails for some reason