info.bioinfweb.commons.io

Class AbstractSaver

java.lang.Object

info.bioinfweb.commons.changemonitor.ChangeMonitor

info.bioinfweb.commons.io.AbstractSaver

All Implemented Interfaces:

ChangeMonitorable, Savable

Direct Known Subclasses:

SwingSaver

public abstract class AbstractSaver
extends ChangeMonitor
implements ChangeMonitorable, Savable

Author:

Ben Söever

Constructor Summary

Constructors

Constructor and Description
AbstractSaver()

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.
abstract 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.
abstract boolean	saveAs() Promts the user der select a path to save the data.
protected abstract void	saveDataToFile(java.io.File file)
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 class info.bioinfweb.commons.changemonitor.ChangeMonitor

hasChanged, registerChange, reset

Methods inherited from class java.lang.Object

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

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

hasChanged, registerChange, reset

Constructor Detail

AbstractSaver

public AbstractSaver()

Method Detail

addFileExtension

public void addFileExtension(java.lang.String ext)

Description copied from interface: Savable

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

Specified by:

addFileExtension in interface Savable

Parameters:

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

getDefaultExtension

public java.lang.String getDefaultExtension()

Description copied from interface: Savable

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.

Specified by:

getDefaultExtension in interface Savable

Returns:

the file extension starting with a "."

getFileExtensions

public java.lang.String[] getFileExtensions()

Specified by:

getFileExtensions in interface Savable

removeFileExtention

public void removeFileExtention(java.lang.String ext)

Specified by:

removeFileExtention in interface Savable

setDefaultExtension

public void setDefaultExtension(java.lang.String ext)

Specified by:

setDefaultExtension in interface Savable

endsWithDefaultExt

public boolean endsWithDefaultExt(java.lang.String path)

Description copied from interface: Savable

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

Specified by:

endsWithDefaultExt in interface Savable

Parameters:

path - the path or file name to test

Returns:

true, if the default extension in present

endsWithValidExt

public boolean endsWithValidExt(java.lang.String path)

Description copied from interface: Savable

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

Specified by:

endsWithValidExt in interface Savable

Parameters:

path - the path or file name to test

Returns:

true, if one valid extension is present

saveDataToFile

protected abstract void saveDataToFile(java.io.File file)

askToSave

public abstract boolean askToSave()

Description copied from interface: Savable

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.

Specified by:

askToSave in interface Savable

Returns:

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

getDefaultName

public java.lang.String getDefaultName()

Description copied from interface: Savable

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

Specified by:

getDefaultName in interface Savable

Returns:

The path or null if none was assigned.

getFile

public java.io.File getFile()

Description copied from interface: Savable

Returns the assigned file.

Specified by:

getFile in interface Savable

Returns:

The path or null if none was assigned.

hasFile

public boolean hasFile()

Description copied from interface: Savable

Checks weather a file has been assigned

Specified by:

hasFile in interface Savable

Returns:

true if a file has been assigned to the data

getDefaultNameOrPath

public java.lang.String getDefaultNameOrPath()

Description copied from interface: Savable

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

Specified by:

getDefaultNameOrPath in interface Savable

save

public boolean save()

Description copied from interface: Savable

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

Specified by:

save in interface Savable

Returns:

true bei Erfolg, false bei Abbruch durch den Benutzer.

saveAs

public abstract boolean saveAs()

Description copied from interface: Savable

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

Specified by:

saveAs in interface Savable

Returns:

true if successful and false if the user cancels

setDefaultName

public void setDefaultName(java.lang.String path)

Description copied from interface: Savable

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

Specified by:

setDefaultName in interface Savable

setFile

public void setFile(java.io.File file)

Description copied from interface: Savable

Manually assignes a path.

Specified by:

setFile in interface Savable