adams.data.conversion
Class ConvertSpreadSheetRows

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

All Implemented Interfaces:

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

public class ConvertSpreadSheetRows
extends AbstractSpreadSheetConversion

Converts the rows in the spreadsheet into a new format.

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
 

-data-row-type <DENSE|SPARSE> (property: dataRowType)
    The type of row to use for the data.
    default: DENSE
 

Version:

$Revision: 6306 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected DataRowType

m_DataRowType the data row type to use.

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

ConvertSpreadSheetRows()

Method Summary

protected SpreadSheet	convert(SpreadSheet input) Generates the new spreadsheet from the input.
String	dataRowTypeTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
DataRowType	getDataRowType() Returns the type of data row to use.
String	globalInfo() Returns a string describing the object.
void	setDataRowType(DataRowType value) Sets the type of data row to use.

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

m_DataRowType

protected DataRowType m_DataRowType

the data row type to use.

Constructor Detail

ConvertSpreadSheetRows

public ConvertSpreadSheetRows()

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 AbstractOptionHandler

setDataRowType

public void setDataRowType(DataRowType value)

Sets the type of data row to use.

Parameters:

value - the type

getDataRowType

public DataRowType getDataRowType()

Returns the type of data row to use.

Returns:

the type

dataRowTypeTipText

public String dataRowTypeTipText()

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