adams.data.io.output
Class SpreadSheetHeatmapWriter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.output.AbstractDataContainerWriter<Heatmap>
              adams.data.io.output.AbstractHeatmapWriter
                  adams.data.io.output.SpreadSheetHeatmapWriter

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractDataContainerWriter>, SizeOfHandler, Serializable, Comparable

public class SpreadSheetHeatmapWriter
extends AbstractHeatmapWriter

Writes heat map files using a spreadsheet 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
 

-output <adams.core.io.PlaceholderFile> (property: output)
    The file to write the container to.
    default: ${TMP}/out.tmp
 

-writer <adams.data.io.output.AbstractSpreadSheetWriter> (property: writer)
    The spreadsheet writer to use for writing the heatmap data.
    default: adams.data.io.output.CsvSpreadSheetWriter
 

Version:

$Revision: 7022 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetWriter

m_Writer the spreadsheet writer to use.

Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

m_Output, m_OutputIsFile

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetHeatmapWriter()

Method Summary

void	defineOptions() Adds options to the internal list of options.
String	getFormatDescription() Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions() Returns the extension(s) of the format.
SpreadSheetWriter	getWriter() Returns the spreadsheet writer in use.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
void	setWriter(SpreadSheetWriter value) Sets the spreadsheet writer to use.
protected boolean	writeData(List<Heatmap> data) Performs the actual writing.
String	writerTipText() Returns the tip text for this property.

Methods inherited from class adams.data.io.output.AbstractHeatmapWriter

getWriters

Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getOutput, isOutputFile, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_Writer

protected SpreadSheetWriter m_Writer

the spreadsheet writer to use.

Constructor Detail

SpreadSheetHeatmapWriter

public SpreadSheetHeatmapWriter()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractDataContainerWriter<Heatmap>

setWriter

public void setWriter(SpreadSheetWriter value)

Sets the spreadsheet writer to use.

Parameters:

value - the writer

getWriter

public SpreadSheetWriter getWriter()

Returns the spreadsheet writer in use.

Returns:

the writer

writerTipText

public String writerTipText()

Returns the tip text for this property.

Returns:

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

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in class AbstractDataContainerWriter<Heatmap>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in class AbstractDataContainerWriter<Heatmap>

Returns:

the extension(s) (without the dot!)

writeData

protected boolean writeData(List<Heatmap> data)

Performs the actual writing.

Specified by:

writeData in class AbstractDataContainerWriter<Heatmap>

Parameters:

data - the data to write

Returns:

true if successfully written