Package adams.data.io.output

Class SimpleStreamSpreadSheetWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractSpreadSheetWriter

adams.data.io.output.SimpleStreamSpreadSheetWriter

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, EncodingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, SpreadSheetWriter, Serializable

public class SimpleStreamSpreadSheetWriter
extends AbstractSpreadSheetWriter

Simple stream format for spreadsheets:
- one spreadsheet row per line in the output
- cells are separated by TAB
- cell format: '<1-based index>:<content-type ID>:<content>'
NB: tabs, new lines etc in the content get backquoted.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-encoding <adams.core.base.BaseCharset> (property: encoding)
    The type of encoding to use when writing using a writer, use empty string 
    for default.
    default: Default
 

-omit-missing <boolean> (property: omitMissing)
    If enabled, missing cells and ones with missing values are omitted.
    default: false
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.io.output.AbstractSpreadSheetWriter

AbstractSpreadSheetWriter.OutputType

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_OmitMissing	whether to omit missing cells or ones with missing value.

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

m_Encoding, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SimpleStreamSpreadSheetWriter()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doWrite(SpreadSheet content, Writer writer)	Performs the actual writing.
SpreadSheetReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
boolean	getOmitMissing()	Returns whether to omit missing cells and ones with missing value.
protected AbstractSpreadSheetWriter.OutputType	getOutputType()	Returns how the data is written.
String	globalInfo()	Returns a string describing the object.
String	omitMissingTipText()	Returns the tip text for this property.
void	setOmitMissing(boolean value)	Sets whether to omit missing cells and ones with missing value.
protected void	writeCell(BufferedWriter writer, int index, Cell cell)	Writes a cell using the supplied writer.
protected boolean	writeRow(BufferedWriter writer, SpreadSheet sheet, Row row)	Writes a row using the supplied writer.

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

canCompress, doWrite, doWrite, encodingTipText, getAdditionalInformation, getDefaultFormatExtension, getEncoding, getWriters, initialize, isStopped, preWriteFile, reset, setEncoding, stopExecution, supportsCompressedOutput, write, write, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_OmitMissing

protected boolean m_OmitMissing

whether to omit missing cells or ones with missing value.

Constructor Detail

SimpleStreamSpreadSheetWriter

public SimpleStreamSpreadSheetWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

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

setOmitMissing

public void setOmitMissing(boolean value)

Sets whether to omit missing cells and ones with missing value.

Parameters:

value - true if to omit

getOmitMissing

public boolean getOmitMissing()

Returns whether to omit missing cells and ones with missing value.

Returns:

true if to omit

omitMissingTipText

public String omitMissingTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

getFormatDescription

public String getFormatDescription()

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

Specified by:

getFormatDescription in interface SpreadSheetWriter

Specified by:

getFormatDescription in class AbstractSpreadSheetWriter

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 interface SpreadSheetWriter

Specified by:

getFormatExtensions in class AbstractSpreadSheetWriter

Returns:

the extension (without the dot!)

getOutputType

protected AbstractSpreadSheetWriter.OutputType getOutputType()

Returns how the data is written.

Specified by:

getOutputType in class AbstractSpreadSheetWriter

Returns:

the type

getCorrespondingReader

public SpreadSheetReader getCorrespondingReader()

Returns, if available, the corresponding reader.

Returns:

the reader, null if none available

writeCell

protected void writeCell(BufferedWriter writer,
                         int index,
                         Cell cell)
                  throws Exception

Writes a cell using the supplied writer.

Parameters:

writer - the writer to use

index - the 0-based index of the cell

cell - the cell to write, null for missing cell

Throws:

Exception

writeRow

protected boolean writeRow(BufferedWriter writer,
                           SpreadSheet sheet,
                           Row row)

Writes a row using the supplied writer.

Parameters:

writer - the writer to use

sheet - the sheet this row belongs to

row - the row to write

Returns:

true if successful written

doWrite

protected boolean doWrite(SpreadSheet content,
                          Writer writer)

Performs the actual writing. The caller must ensure that the writer gets closed.

Overrides:

doWrite in class AbstractSpreadSheetWriter

Parameters:

content - the spreadsheet to write

writer - the writer to write the spreadsheet to

Returns:

true if successfully written