adams.data.conversion
Class SpreadSheetAddFormulaColumn

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.SpreadSheetAddFormulaColumn

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, 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.

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.
 

-header <java.lang.String> (property: header)
    The title of the formula column.
    default: Sum
 

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

-rows <adams.core.Range> (property: rows)
    The range of rows to add the 'sum' 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: 6706 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_Formula the formula to add.
protected String	m_Header the the column header.
protected Range	m_Rows the rows to add the formula to.
static String	PLACEHOLDER_LAST_COL the placeholder for the last column.
static String	PLACEHOLDER_ROW the placeholder for the 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

SpreadSheetAddFormulaColumn()

Method Summary

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.
String	getFormula() Returns the formula in use.
String	getHeader() Returns the column header in use.
Range	getRows() Returns the range of rows to add the sum for.
String	globalInfo() Returns a string describing the object.
String	headerTipText() Returns the tip text for this property.
String	rowsTipText() Returns the tip text for this property.
void	setFormula(String value) Sets the formula to use.
void	setHeader(String value) Sets the column header to use.
void	setRows(Range value) Sets the range of rows to add the sum for.

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_ROW

public static final String PLACEHOLDER_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

m_Header

protected String m_Header

the the column header.

m_Formula

protected String m_Formula

the formula to add.

m_Rows

protected Range m_Rows

the rows to add the formula to.

Constructor Detail

SpreadSheetAddFormulaColumn

public SpreadSheetAddFormulaColumn()

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

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(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.

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.

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