Package adams.data.io.output

Interface MultiSheetSpreadSheetWriter

All Superinterfaces:

Destroyable, OptionHandler, SpreadSheetWriter, Stoppable, StoppableWithFeedback

All Known Implementing Classes:

AbstractMultiSheetFormattedSpreadSheetWriter, AbstractMultiSheetSpreadSheetWriter, AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport, ExcelSpreadSheetWriter, ExcelStreamingSpreadSheetWriter, GnumericSpreadSheetWriter, Mat5SpreadSheetWriter, ODFSpreadSheetWriter

public interface MultiSheetSpreadSheetWriter
extends SpreadSheetWriter

Interface for spreadsheet writers that can write multiple sheets into a single document.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
boolean	canWriteMultiple()	Returns whether the writer supports writing multiple sheets.
boolean	write(SpreadSheet[] content, File file)	Writes the spreadsheets to the specified file.
boolean	write(SpreadSheet[] content, OutputStream stream)	Writes the spreadsheets to the given output stream.
boolean	write(SpreadSheet[] content, Writer writer)	Writes the spreadsheets to the given writer.
boolean	write(SpreadSheet[] content, String filename)	Writes the spreadsheets to the given file.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.data.io.output.SpreadSheetWriter

getCorrespondingReader, getFormatDescription, getFormatExtensions, reset, write, write, write, write

Methods inherited from interface adams.core.Stoppable

stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback

isStopped

Method Detail

canWriteMultiple

boolean canWriteMultiple()

Returns whether the writer supports writing multiple sheets.

Returns:

true if it can write multiple sheets

write

boolean write(SpreadSheet[] content,
              File file)

Writes the spreadsheets to the specified file.

Parameters:

content - the content to write

file - the file to write to

Returns:

true if successfully written

write

boolean write(SpreadSheet[] content,
              String filename)

Writes the spreadsheets to the given file.

Parameters:

content - the spreadsheet to write

filename - the file to write the spreadsheet to

Returns:

true if successfully written

write

boolean write(SpreadSheet[] content,
              OutputStream stream)

Writes the spreadsheets to the given output stream. The caller must ensure that the stream gets closed.

Parameters:

content - the spreadsheet to write

stream - the output stream to write the spreadsheet to

Returns:

true if successfully written

write

boolean write(SpreadSheet[] content,
              Writer writer)

Writes the spreadsheets to the given writer. The caller must ensure that the writer gets closed.

Parameters:

content - the spreadsheet to write

writer - the writer to write the spreadsheet to

Returns:

true if successfully written