info.bioinfweb.commons.io

Interface Savable

All Superinterfaces:

ChangeMonitorable

All Known Subinterfaces:

SwingSavable

All Known Implementing Classes:

AbstractSaver, SwingSaver

public interface Savable
extends ChangeMonitorable

Method Summary

Modifier and Type	Method and Description
void	addFileExtension(java.lang.String ext) Adds an file extension to the list of the allowed file extensions which can be entered by the user in the save as dialog.
boolean	askToSave() Promts the user wheather to save changed data and calls save() if necessary.
boolean	endsWithDefaultExt(java.lang.String path) Tests if the given string ends with the default file extension.
boolean	endsWithValidExt(java.lang.String path) Tests if the given string ends with one of the valid file extensions stored.
java.lang.String	getDefaultExtension() The file extension which should be add to file name chosen in the save as dialog, if not one of the allowed ones is already present.
java.lang.String	getDefaultName() The path that should be proposed by the saveAs()-method if no path has been assigned.
java.lang.String	getDefaultNameOrPath() The path of the assigned file or the default name if no file has been specified.
java.io.File	getFile() Returns the assigned file.
java.lang.String[]	getFileExtensions()
boolean	hasFile() Checks weather a file has been assigned
void	removeFileExtention(java.lang.String ext)
boolean	save() This method should save the data to a file defined by the path and should call saveAs() if no path was assigned.
boolean	saveAs() Promts the user der select a path to save the data.
void	setDefaultExtension(java.lang.String ext)
void	setDefaultName(java.lang.String path) Sets the path that should be proposed by the saveAs()-method if no path has been assigned.
void	setFile(java.io.File file) Manually assignes a path.

Methods inherited from interface info.bioinfweb.commons.changemonitor.ChangeMonitorable

hasChanged, registerChange, reset

Method Detail

getDefaultExtension

java.lang.String getDefaultExtension()

The file extension which should be add to file name chosen in the save as dialog, if not one of the allowed ones is already present.

Returns:

the file extension starting with a "."

setDefaultExtension

void setDefaultExtension(java.lang.String ext)

addFileExtension

void addFileExtension(java.lang.String ext)

Adds an file extension to the list of the allowed file extensions which can be entered by the user in the save as dialog.

Parameters:

ext - the extension to add starting with a "."

removeFileExtention

void removeFileExtention(java.lang.String ext)

getFileExtensions

java.lang.String[] getFileExtensions()

endsWithValidExt

boolean endsWithValidExt(java.lang.String path)

Tests if the given string ends with one of the valid file extensions stored.

Parameters:

path - the path or file name to test

Returns:

true, if one valid extension is present

endsWithDefaultExt

boolean endsWithDefaultExt(java.lang.String path)

Tests if the given string ends with the default file extension.

Parameters:

path - the path or file name to test

Returns:

true, if the default extension in present

hasFile

boolean hasFile()

Checks weather a file has been assigned

Returns:

true if a file has been assigned to the data

getFile

java.io.File getFile()

Returns the assigned file.

Returns:

The path or null if none was assigned.

setFile

void setFile(java.io.File file)

Manually assignes a path.

getDefaultName

java.lang.String getDefaultName()

The path that should be proposed by the saveAs()-method if no path has been assigned.

Returns:

The path or null if none was assigned.

setDefaultName

void setDefaultName(java.lang.String path)

Sets the path that should be proposed by the saveAs()-method if no path has been assigned.

getDefaultNameOrPath

java.lang.String getDefaultNameOrPath()

The path of the assigned file or the default name if no file has been specified.

save

boolean save()

This method should save the data to a file defined by the path and should call saveAs() if no path was assigned.

Returns:

true bei Erfolg, false bei Abbruch durch den Benutzer.

saveAs

boolean saveAs()

Promts the user der select a path to save the data. The values of getPAth() or getDefaultPath() should be suggestet.

Returns:

true if successful and false if the user cancels

askToSave

boolean askToSave()

Promts the user wheather to save changed data and calls save() if necessary. If nothing has changed, there will be no prompt and the result is true.

Returns:

true if the file can be closed or false if the user wants to cancel