All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface framework.Data

public interface Data
extends StoreElement
An object that implements this interface can serve as input for a module and can be used as the output of a module. This interface extends interface store.StoreElement, so objects that implement this interface can be stored in a class that implements the Store interface.

Version:
$Revision: 1.12 $

Method Index

o canDisplay()
Check whether this class can display the Data or not.
o canLoad()
Check whether this class can load the data from disk or not.
o canSave()
Check whether this class can save the data to disk or not.
o display(String, String)
Display the data of the object to the user of the Framework.
o load(String)
Load the contents of this data object from a specified file.
o loadFileAvailable(String)
Checks whether the input file is available or not.
o save(String)
Save the contents of this data object to a specified file.
o saveFileAvailable(String)
Checks whether a file can be saved with this name and the first extension as it is defined in the data type class.

Methods

o load 
 public abstract void load(String filename) throws FileNotFoundException, IOException
Load the contents of this data object from a specified file.

Parameters:
filename - the name of the file from which to load.
o save 
 public abstract void save(String filename) throws FileNotFoundException, IOException
Save the contents of this data object to a specified file.

Parameters:
filename - the name of the file in which to store the data.
o display 
 public abstract DataVisualisation display(String title,
                                           String filename)
Display the data of the object to the user of the Framework.

Parameters:
title - a text to use identify the Data when it is shown to the user of the Framework. For example, if a window is used to show the Data, this text can be used for the title of the window.
filename - a filename that will be used as a default in case the user of the Framework wants to save the Data while it is shown.
Returns:
an instance of a class that implements the DataVisualisation interface. The instance serves as a link to whatever representation, graphical or otherwise, the Data class has made to display the Data. The Framework uses these links to keep track of the windows that are displaying Data. With this information, it can close all these windows if the user of the Framework desires.
See Also:
DataVisualisation
o canSave 
 public abstract boolean canSave()
Check whether this class can save the data to disk or not.

o canLoad 
 public abstract boolean canLoad()
Check whether this class can load the data from disk or not.

o canDisplay 
 public abstract boolean canDisplay()
Check whether this class can display the Data or not.

o loadFileAvailable 
 public abstract File loadFileAvailable(String filename)
Checks whether the input file is available or not. The input file that is checked consists of the filename and extensions (tags) that are/must be defined in the data classes.

o saveFileAvailable 
 public abstract File saveFileAvailable(String filename) throws DataException
Checks whether a file can be saved with this name and the first extension as it is defined in the data type class.

Returns:
the File if the file can be saved. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index