adams.data.conversion
Class MergeSpreadSheetColumns

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

All Implemented Interfaces:

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

public class MergeSpreadSheetColumns
extends AbstractSpreadSheetConversion

Merges two or more columns in a spreadsheet into a single column.

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
 

-columns <adams.core.Range> (property: columns)
    The range of columns to merge into a single one; 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
 

-glue <java.lang.String> (property: glue)
    The 'glue' string to use between two values that get merged.
    default: 
 

Version:

$Revision: 6301 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Range	m_Columns the columns to merge.
protected String	m_Glue the concatenation string to use.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

MergeSpreadSheetColumns()

Method Summary

String	columnsTipText() Returns the tip text for this property.
protected SpreadSheet	convert(SpreadSheet input) Returns a string describing the object.
void	defineOptions() Adds options to the internal list of options.
Range	getColumns() Returns the range of columns to merge.
String	getGlue() Returns the "glue" to use between two columns.
String	globalInfo() Returns a string describing the object.
String	glueTipText() Returns the tip text for this property.
void	setColumns(Range value) Sets the range of columns to merge.
void	setGlue(String value) Sets the "glue" to use between two columns.

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

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_Columns

protected Range m_Columns

the columns to merge.

m_Glue

protected String m_Glue

the concatenation string to use.

Constructor Detail

MergeSpreadSheetColumns

public MergeSpreadSheetColumns()

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

setColumns

public void setColumns(Range value)

Sets the range of columns to merge.

Parameters:

value - the range

getColumns

public Range getColumns()

Returns the range of columns to merge.

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.

setGlue

public void setGlue(String value)

Sets the "glue" to use between two columns.

Parameters:

value - the glue

getGlue

public String getGlue()

Returns the "glue" to use between two columns.

Returns:

the glue

glueTipText

public String glueTipText()

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

Returns a string describing the object.

Specified by:

convert in class AbstractSpreadSheetConversion

Parameters:

input - the incoming spreadsheet

Returns:

a description suitable for displaying in the gui

Throws:

Exception - if conversion fails for some reason