Package adams.data.io.output

Interface AppendableSpreadSheetWriter

All Known Implementing Classes:

AccessSpreadSheetWriter, CsvSpreadSheetWriter, SqlDumpSpreadSheetWriter, TsvSpreadSheetWriter

public interface AppendableSpreadSheetWriter

Interface for spreadsheet writers that can append data to existing files.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	appendingTipText()	Returns the tip text for this property.
boolean	canAppend(SpreadSheet sheet)	Checks whether we can append the specified spreadsheet to the existing file.
boolean	getFileExists()	Returns whether the output file already exists.
boolean	getKeepExisting()	Returns whether any existing file is kept on first execution.
boolean	isAppending()	Returns whether the next spreadsheet will get appended.
String	keepExistingTipText()	Returns the tip text for this property.
void	setAppending(boolean value)	Sets whether the next write call is to append the data to the existing file.
void	setFileExists(boolean value)	Sets whether the output file already exists.
void	setKeepExisting(boolean value)	Sets whether to keep any existing file on first execution.

Method Detail

canAppend

boolean canAppend(SpreadSheet sheet)

Checks whether we can append the specified spreadsheet to the existing file.

Parameters:

sheet - the spreadsheet to append to the existing one

Returns:

true if appending is possible

setFileExists

void setFileExists(boolean value)

Sets whether the output file already exists.

Parameters:

value - true if the output file already exists

getFileExists

boolean getFileExists()

Returns whether the output file already exists.

Returns:

true if the output file already exists

setAppending

void setAppending(boolean value)

Sets whether the next write call is to append the data to the existing file.

Parameters:

value - true if to append

isAppending

boolean isAppending()

Returns whether the next spreadsheet will get appended.

Returns:

true if append is active

appendingTipText

String appendingTipText()

Returns the tip text for this property.

Returns:

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

setKeepExisting

void setKeepExisting(boolean value)

Sets whether to keep any existing file on first execution.

Parameters:

value - if true then existing file is kept

getKeepExisting

boolean getKeepExisting()

Returns whether any existing file is kept on first execution.

Returns:

true if existing file is kept

keepExistingTipText

String keepExistingTipText()

Returns the tip text for this property.

Returns:

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