adams.data.conversion
Class RenameSpreadSheetColumn

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

All Implemented Interfaces:

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

public class RenameSpreadSheetColumn
extends AbstractInPlaceSpreadSheetConversion

Renames a single column in a spreadsheet.

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
 

-column <adams.core.Index> (property: column)
    The index of the column to rename; An index is a number starting with 1; 
    the following placeholders can be used as well: first, second, third, last
    _2, last_1, last
    default: first
 

-new-name <java.lang.String> (property: newName)
    The new name of the column.
    default: Blah
 

Version:

$Revision: 6866 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetColumnIndex	m_Column the column to rename.
protected String	m_NewName the new name for the column.

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

RenameSpreadSheetColumn()

Method Summary

String	columnTipText() 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.
SpreadSheetColumnIndex	getColumn() Returns the index of the column to rename.
String	getNewName() Returns the new name for the column.
String	globalInfo() Returns a string describing the object.
String	newNameTipText() Returns the tip text for this property.
void	setColumn(SpreadSheetColumnIndex value) Sets the index of the column to rename.
void	setNewName(String value) Sets the new name of the column.

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

m_Column

protected SpreadSheetColumnIndex m_Column

the column to rename.

m_NewName

protected String m_NewName

the new name for the column.

Constructor Detail

RenameSpreadSheetColumn

public RenameSpreadSheetColumn()

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

setColumn

public void setColumn(SpreadSheetColumnIndex value)

Sets the index of the column to rename.

Parameters:

value - the index

getColumn

public SpreadSheetColumnIndex getColumn()

Returns the index of the column to rename.

Returns:

the index

columnTipText

public String columnTipText()

Returns the tip text for this property.

Returns:

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

setNewName

public void setNewName(String value)

Sets the new name of the column.

Parameters:

value - the name

getNewName

public String getNewName()

Returns the new name for the column.

Returns:

the name

newNameTipText

public String newNameTipText()

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