adams.data.io.input
Class SpreadSheetHeatmapReader

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.input.AbstractDataContainerReader<Heatmap>
              adams.data.io.input.AbstractHeatmapReader
                  adams.data.io.input.SpreadSheetHeatmapReader

All Implemented Interfaces:

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

public class SpreadSheetHeatmapReader
extends AbstractHeatmapReader

Turns spreadsheets into heatmaps.

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
 

-input <adams.core.io.PlaceholderFile> (property: input)
    The file to read and turn into a container.
    default: ${CWD}
 

-create-dummy-report (property: createDummyReport)
    If true, then a dummy report is created if none present.
 

-reader <adams.data.io.input.AbstractSpreadSheetReader> (property: reader)
    The reader to use for reading the spreadsheet data.
    default: adams.data.io.input.CsvSpreadSheetReader
 

Version:

$Revision: 7022 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected SpreadSheetReader

m_Reader the spreadsheet reader to use.

Fields inherited from class adams.data.io.input.AbstractDataContainerReader

m_CreateDummyReport, m_Input, m_InputIsFile, m_Processed, m_ReadData

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetHeatmapReader()

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.
SpreadSheetReader	getReader() Returns the spreadsheet reader in use.
String	globalInfo() Returns a string describing the object.
protected void	readData() Performs the actual reading.
String	readerTipText() Returns the tip text for this property.
void	setReader(SpreadSheetReader value) Sets the spreadsheet reader to use.

Methods inherited from class adams.data.io.input.AbstractHeatmapReader

getReaders

Methods inherited from class adams.data.io.input.AbstractDataContainerReader

checkData, cleanUp, compareTo, createDummyReport, createDummyReportTipText, destroy, doRead, equals, forCommandLine, forName, getCreateDummyReport, getInput, initialize, inputTipText, isInputFile, postProcessData, read, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

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_Reader

protected SpreadSheetReader m_Reader

the spreadsheet reader to use.

Constructor Detail

SpreadSheetHeatmapReader

public SpreadSheetHeatmapReader()

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 AbstractDataContainerReader<Heatmap>

setReader

public void setReader(SpreadSheetReader value)

Sets the spreadsheet reader to use.

Parameters:

value - the reader

getReader

public SpreadSheetReader getReader()

Returns the spreadsheet reader in use.

Returns:

the reader

readerTipText

public String readerTipText()

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 AbstractDataContainerReader<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 AbstractDataContainerReader<Heatmap>

Returns:

the extension(s) (without the dot!)

readData

protected void readData()

Performs the actual reading.

Specified by:

readData in class AbstractDataContainerReader<Heatmap>