Description of the public Framework classes

This page contains a short description of each public class of the Framework. The first column of the table contains the name of the directory of the Java source file. If the Java source file is found in the directory containing the default package of the Framework, the directory name is left out. The second column contains the name of the Java source file. The third column contains the description.

Since the Framework is still under development, some descriptions may be incomplete or invalid. For example, some descriptions contain an error message generated by the program that is used to generate this list.

Directory Source file Description

AboutDialog.java A basic extension of the java.awt.Dialog class, used to display general information about the Framework to the user when he or she selects the About menu item.

AddConnectionResult.java A class that implements an enumeration type that defines the values that can be returned by method Network.addConnection(). Each value of this enumeration type has a descriptive String. This String is returned by the method toString().

ClassLoadResult.java An enumeration type that defines the different errors that may occur when trying to load class file.

CommandDataInputStream.java Customized DataInputStream for the reading of Module Description Files.

Commands.java Class containing a set of constants used to identify the commands in the module description file.

Connection.java A connection between an InConnector and an OutConnector.

ConnectionDisconnector.java A ConnectionStoreIterator that disconnects all Connections from what they are connected to. This class overrides the doAll method. The doAll method in the superclass uses a java.util.Enumeration to traverse the ConnectionStore. The version of that method in this class traverses the ConnectionStore by using a for-loop. This is necessary because this class is supposed to disconnect the Connections, which means that they will be removed from the ConnectionStore. When elements are removed from the Store while traversing the store using a Enumeration, some elements are skipped. For efficiency, the ConnectionStore is traversed from the last element to the first.

ConnectionStore.java This class implements a Store for Connections using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

ConnectionStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ConnectionStore and a method action() that only works on a Connection. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

Connector.java Connectors represent the input and output of a module. Two Connectors of different modules, but of the same type, can be connected to each other using a Connection.

ConnectorClearer.java A ConnectorStoreIterator that removes data from each Connector.

ConnectorCollector.java A ModuleStoreIterator that collects all Connectors of all Modules in the Store.

ConnectorDisconnector.java A ConnectorStoreIterator that disconnects all Connectors from their Connections.

ConnectorStore.java This class implements a Store for Connectors using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

ConnectorStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ConnectorStore and a method action() that only works on a Connector. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

DataCollector.java A ConnectorStoreIterator that collects the data of all Connectors.

DataDistributor.java A ConnectorStoreIterator that distributes the Data in a specific DataStore over the Connectors in a ConnectorStore. Each element of the DataStore is given to the Connector in the ConnectorStore whose index corresponds to the index of the DataStore element.

DataLoader.java An InConnectorStoreIterator that loads data for each InConnector that has its serveAsNetworkInput flag set to true and does not already have data associated with it. NYI: in case of an error while loading the data, executing of the entire network should stop, so the error should be propagated through to the level of Network.run() somehow.

DataSaver.java An OutConnectorStoreIterator that asks the OutConnectors to save their Data.

DataSetter.java A ConnectionStoreIterator that gives all Connections a specified Data object using Connection.setData().

DataType.java The type of the data a module operates on.

DataTypeChecker.java A ConnectorStoreIterator that compares the types of the data of the Connectors in a ConnectorStore with the types of data in a specific DataStore.

DataVisualisationCloser.java /home/maarten/framework/bin/FirstDocComment: ./DataVisualisationCloser.java: no /** found

DataVisualisationStore.java This class implements a Store for instances of classes that implement the DataVisualisation interface. This Store uses java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

DataVisualisationStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DataVisualisationStore and a method action() that only works on a DataVisualisation. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

DisplayComponent.java Interface all classes used for the graphical user interface of the network must implement.

DisplayConnection.java [Insert purpose of class here]
A DisplayConnection is normally one line, from the DisplayConnector for the OutConnector to the DisplayConnector for the InConnector. But if the DisplayConnector for the OutConnector is drawn higher (has smaller y-coordinate) than the DisplayConnector for the InConnector, the DisplayConnection consists of three lines. The first line is a line of fixed, short length from the DisplayConnector for the OutConnector that goes straight down. The third line is a line of fixed, short length from the DisplayConnector for the InConnector that goes straight up. The second line connects the first line to the third. Such a DisplayConnection is said to use fixed points.

DisplayConnectionAdder.java A ConnectionStoreIterator that adds all Connections to a DisplayNetwork.

DisplayConnectionPainter.java /home/maarten/framework/bin/FirstDocComment: ./DisplayConnectionPainter.java: no /** found

DisplayConnectionStore.java This class implements a Store for DisplayConnections using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

DisplayConnectionStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DisplayConnectionStore and a method action() that only works on a DisplayConnection. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

DisplayConnector.java

DisplayConnectorCreator.java A ConnectorStoreIterator that creates a DisplayConnector for every Connector in the ConnectorStore.

DisplayConnectors.java /home/maarten/framework/bin/FirstDocComment: ./DisplayConnectors.java: no /** found

DisplayMessage.java /home/maarten/framework/bin/FirstDocComment: ./DisplayMessage.java: no /** found

DisplayModule.java /home/maarten/framework/bin/FirstDocComment: ./DisplayModule.java: no /** found

DisplayModuleAdder.java A ModuleStoreIterator that adds all Modules to a DisplayNetwork (the graphical view on the Network).

DisplayModuleMain.java the entire DisplayModule that this DisplayModuleMain is a part of.

DisplayNetwork.java An user interface component that shows a Network in a graphical way; the Modules are represented by boxes and the Connections by lines connecting the boxes.

EditModuleParameters.java Module parameters values and other module settings can be edited in EditModuleParameters. This dialog can be used to edit the parameters of a module. The parameters are read from the Module Description File and the values defined in this dialog are passed on to the Module.

EndModuleSelector.java A ModuleSelector which selects all end modules.

Executer.java The parent class of all classes that can schedule and execute the modules in a run path.

FileAvailableChecker.java This ConnectorStoreIterator checks if all Connectors in the Store answer true to their fileAvailable() method.

FileLoadResult.java An enumeration type that defines the different errors that may occur when a Data class tries to load a file.

FileSaveResult.java An enumeration type that defines the different errors that may occur when a Data class tries to save a file.

FileStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a FileStore and a method action() that only works on a File. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

FlowDownConnectionStoreIterator.java FlowDownConnectionStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on the connections of this StoreIterator and proceeds to underlaying modules via the inconnector of the connections. The module obtained from a connection is processed via the FlowDownConnectionStore- Iterator.

FlowDownMarkModule.java Marks modules. An instance of this class is passed as parameter to the FlowDownModuleStoreIterator that will walk through the network of modules. The methods defined in this class will be called every time a module is investigated.

FlowDownModuleStoreIterator.java FlowDownModuleStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on modules of this StoreIterator and proceeds to underlaying modules via the outconnectors by using the FlowDownOutConnectorStoreIterator.

FlowDownOutConnectorStoreIterator.java FlowDownOutConnectorStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on out connectors of this StoreIterator and proceeds to underlaying modules via the connections defined in the out connector by using the FlowDownConnectionStoreIterator.

FlowIteration.java An abstract class that defines methods that are called in the FlowDown- ModuleStoreIterator clas. The methods declared here can be defined by sub classes of this abstract class (i.e. MarkModule).

FlowUpInConnectorStoreIterator.java FlowUpInConnectorStoreIterator is one of two classes that can be used to walk (depth first from bottom to top) through a network of modules. This class uses the action method on in connectors of this StoreIterator and proceeds to the module above via the connection defined in the in connector.

FlowUpMarkModule.java Marks modules. An instance of this class is (for example) passed as parameter to the FlowUpModuleStoreIterator that will walk through the network of modules. The method defined in this class will be called every time a module is investigated.

FlowUpModuleStoreIterator.java FlowUpModuleStoreIterator is one of two classes that can be used to walk (depth first bottom-up) through a network of modules. This class uses the action method on modules of this StoreIterator and proceeds to modules above via the inconnectors by using the FlowUpInConnectorStoreIterator.

FontSelector.java An implementation of interface framework.awt.FontSelector.
This class serves as the interface between the Framework properties and parts of the Framework that need Fonts. This class can return a Font (using method getFont()) for a specific Framework property and knows what to do if the property does not exist.

Framework.java The main class of the framework. This class contains data that is global to the framework. It also contains the main() method.

GraphicalViewFrame.java A rectangle specifying default values for the position and size of the Frame. These values are only used if the Frame cannot find a position and size in the properties of the Framework.

HashtableInfoHandler.java /home/maarten/framework/bin/FirstDocComment: ./HashtableInfoHandler.java: no /** found

HelpTexts.java A store for keeping the help texts. The help texts are referenced using a String called the `subject'. With a subject, you can retrieve the corresponding help text. This class contains the mapping from subjects to help text files. This class also buffers the help texts in a Hashtable.

HelpViewer.java The abstract super class of all help text viewer classes. It gets its texts from a HelpTexts instance that is passed to the constructor of this class. This way, the texts that are displayed are independent of the way they are displayed, so the same texts can be used in several HelpViewers specialized in several contexts.

HelpViewerDialog.java A subclass of HelpViewer that shows the help texts in a TextDialog.

InConnector.java Inconnectors are those connectors of a module that provide the input for a module.

InConnectorCollector.java A ConnectorCollector that collects all InConnectors of all Modules in the Store.

InConnectorMarker.java A ConnectorStoreIterator that sets the serveAsNetworkInput flag of a set of InConnectors.

InConnectorSelector.java An abstract InConnectorStoreIterator that can select InConnectors that satisfy a specified condition.

InConnectorStore.java This subclass of ConnectorStore implements a Store for InConnectors

InConnectorStoreIterator.java This class is an extension of ConnectorStoreIterator. This class contains a method doAll() that only works on an InConnectorStore and a method action() that only works on an InConnector. The methods doAll() and action() inherited from ConnectorStoreIterator are `disabled' in this class: when called, they only generate an exception.

InfluencesModule.java Finds out if a module A is influenced by a module B. That is if a module A receives data from module B then it is influenced by module A. This class is (for example) used when a loop check is performed in addConnection of Network. The methods followAction (that marks the module) and modulePostCondition are defined in the abstract class MarkModule.

InfoHandler.java /home/maarten/framework/bin/FirstDocComment: ./InfoHandler.java: no /** found

InvalidInternalStateException.java Thrown when the program notices that the internal datastructures are invalid.

ListView.java An user interface component that shows a Network by means of two lists; one containing the Modules and one containing the Connections between the Modules. This class can be used as a view in the Model-View-Controller paradigm, because it implements Observer.

MDFConnectorException.java Thrown when an error occurs while reading a Connector from a Module Description File.

MakeModules.java Automatically generate the intermediate java and C(++) files necessary for calling a C module. Furthermore this class contains a method that gives the module developer directions of what to do after the intermediate files are generated.

MarkModule.java Abstract class that marks modules. An instances of a super class of this class can be passed on as parameter to the either the FlowUpModuleStore- Iterator or FlowDownModuleStoreIterator that will walk up resp. down through the network of modules. The methods defined in this class will be called every time a module is investigated. (Some of the) methods defined here are overrided in sub classes of this class (i.e modulePostCondition is defined in the classes FlowUpMarkModule and FlowDownMarkModule in the class InfluencesModule.

MarkedModuleSelector.java A ModuleSelector which selects all marked modules.

ModelEvent.java /home/maarten/framework/bin/FirstDocComment: ./ModelEvent.java: no /** found

ModelEventId.java /home/maarten/framework/bin/FirstDocComment: ./ModelEventId.java: no /** found

Module.java An occurrance of a module in a network.

ModuleClearer.java A ModuleStoreIterator that removes the Data stored at all Modules.

ModuleGeneratorDialog.java Automatically generate the intermediate java and C(++) files necessary for calling a C module. Furthermore this class contains a method that gives the module developer directions of what to do after the intermediate files are generated.

ModulePreparer.java A ModuleStoreIterator that prepares all Modules for running by calling their prepareToRun() method.

ModuleRemover.java A ModuleStoreIterator that removes the Modules it iterates over from a specified ModuleStore.

ModuleRunner.java A ModuleStoreIterator that runs all Modules by calling their run() method.

ModuleSelector.java An abstract ModuleStoreIterator that can select Modules that satisfy a specified condition.

ModuleStore.java This class implements a Store for Modules using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

ModuleStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ModuleStore and a method action() that only works on a module. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

ModuleType.java Class containing the information that several occurrances of the same Module have in common.

Network.java A class describing a network.

NetworkFrame.java This simple extension of the java.awt.Frame class contains all the elements necessary to act as the main window of an application.

NetworkInputSelector.java An InConnectorSelector that selects the InConnectors that serve as input for a collection of modules. These are the InConnectors that do not receive their input from other modules in the collection because they have no connection to modules in the collection. They either have no connection at all, or are connected to a module that is not in the collection.

NetworkLayout.java /home/maarten/framework/bin/FirstDocComment: ./NetworkLayout.java: no /** found

NetworkObservable.java This method is overridden so notification for objects that are not part of the model can be suppressed. This is a temporary fix. It should be replaced by view-specific information storage in the model or some other scheme or division of the model in various sub-models. Notifications for Modules (or their Connectors) are suppressed if the Module is not part of a model.

NetworkState.java An enumeration type that defines the different states a Network may be in.

Notifiable.java /home/maarten/framework/bin/FirstDocComment: ./Notifiable.java: no /** found

OutConnector.java Outconnectors are those connectors of a module that provide the output of a module.

OutConnectorCollector.java A ConnectorCollector that collects all OutConnectors of all Modules in the Store.

OutConnectorStore.java This subclass of ConnectorStore implements a Store for OutConnectors

OutConnectorStoreIterator.java This class is an extension of ConnectorStoreIterator. This class contains a method doAll() that only works on an OutConnectorStore and a method action() that only works on an OutConnector. The methods doAll() and action() inherited from ConnectorStoreIterator are `disabled' in this class: when called, they only generate an exception.

QuitDialog.java A basic extension of the java.awt.Dialog class, used to ask the user for confirmation when he or she selects the Exit menu item.

ResultHandler.java /home/maarten/framework/bin/FirstDocComment: ./ResultHandler.java: no /** found

ResultSelector.java /home/maarten/framework/bin/FirstDocComment: ./ResultSelector.java: no /** found

RunnableModuleSelector.java This ModuleSelector subclass selects all Modules that have all their input available in memory or on disk.

SelectBasenameDialog.java A basic extension of the java.awt.Dialog class that is used to select basenames.

SequentialExecuter.java Being a subclass of Executer, this class can schedule and execute a set of Modules. It executes them sequentially, one after another.

StartModuleSelector.java A ModuleSelector which selects all start modules.

StoreAppender.java A StoreIterator that adds all elements of a Store to another Store. Just like ModuleStoreIterator, it `disables' the methods doAll() and action() from the interface Iterator (inherited through StoreIterator), because they work on Objects, while this class is designed to work only on Stores.

Timer.java notification (true) or if it should continue to send notifications until it is stopped (false).

UnMarkModule.java Unmarks the modules that are marked. An instance of this class is passed as parameter to the FlowDownModuleStoreIterator that will walk through the network of modules. The methods defined in this class will be called every time a module is investigated.

ViewSelector.java Selects the view. If there is more than 1 view, the first one is chosen. The display can return an object (containing display information) to the 'requester' by calling the addInfo method.

Module ImageData.java ImageData is the java class that contains pictures. If a gif is read from disk in java the data is stored in an ImageData object.

Module/picture FileInput.java FileInput is a class that is used for the data input.

Module/picture GifEncoder.java Write out an image as a GIF.
Fetch the software.
Fetch the entire Acme package.

Module/picture ImageEncoder.java Abstract class for writing out an image.
A framework for classes that encode and write out an image in a particular file format.
This provides a simplified rendition of the ImageConsumer interface. It always delivers the pixels as ints in the RGBdefault color model. It always provides them in top-down left-right order. If you want more flexibility you can always implement ImageConsumer directly.
Fetch the software.
Fetch the entire Acme package.

Module/picture ImageLoader.java ImageLoader is the superclass for various image loaders. In particular the BMP and TGA ImageLoader classes. Classes from http://village.ch/~schoen/

Module/picture IntHashtable.java A Hashtable that uses ints as the keys.
Use just like java.util.Hashtable, except that the keys must be ints. This is much faster than creating a new Integer for each access.
Fetch the software.
Fetch the entire Acme package.

Module/picture JpegEncoder.java Write out an image as a JPEG. DOESN'T WORK YET.
Fetch the software.
Fetch the entire Acme package.

Module/picture NoSuchLoaderException.java An exception indicated that file format was wrong

Module/picture PpmEncoder.java Write out an image as a PPM.
Writes an image onto a specified OutputStream in the PPM file format.
Fetch the software.
Fetch the entire Acme package.

Module/picture UnsupportedFormatException.java An exception indicated that file format is not supported

Module/picture WrongFileFormatException.java An exception indicated that file format was wrong

framework Data.java 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.
Among other things, this interface contains methods for loading and saving the Data and displaying the Data to the user of the Framework. These methods are called load, save and display (save is overloaded). Not every Data class has to provide this functionality. For each of these methods, this interface contains a corresponding boolean variable which indicates wether a particular Data class can load, save or display its data. Before any of these methods are used by the Framework, it checks the corresponding boolean variable and only calls the method if the variable has the value true. These variables are called canLoad, canSave, canSaveStream and canDisplay. If a Data class does not provide functionality for loading, saving or displaying its data, it still has to provide an implementation for each of these methods, in order to implement this interface. The Data class can give an empty implementation and set the corresponding access variable to false. The easiest way to create a Data class is to extend class ModuleData. This abstract class implements the Data interface and has useful implementations for most of the methods from the Data interface.
The access variables, canLoad, canSave, canSaveStream and canDisplay are declared in this interface with a default value which is false. Data classes that want to change this value have to contain a public and static boolean variable with the same name. Such a variable hides the variable declared in this interface. A method that wants to access one of these access variables in the Data class must use a reference which is of the same type as the Data class. If the reference is of the same type as this interface, the method will get the value declared here, the hidden value. If only a reference of the same type as this interface is available, the correct value can be retrieved using reflection.

framework DataException.java A DataException will occur when:

Framework data types are improperly defined. For example when a data type has a save method, but no save tags are defined.
Framework data can not be saved or loaded.

framework DataVisualisation.java /home/maarten/framework/bin/FirstDocComment: framework/DataVisualisation.java: no /** found

framework Debug.java Help with printing of debug information. Debug information can be printed with method println(). Printing debug information can be enabled or disabled by using the system property "debug".

framework FrameworkAgent.java The FrameworkAgent is the Framework's run-time "representative" towards the Modules, Data classes and other classes external to the Framework. The FrameworkAgent can be used to query the Framework for some of its variables that may be interesting to external classes, like its MessagesDialog and its FontSelector.

framework JNIDataException.java When data is incorrectly accessed from a native (c, c++) module a JNIDataException will be thrown. The Exception will be caught as an JNIException by the Framework.

framework JNIException.java When data or parameters are incorrectly accessed from a native (c, c++) module JNIDataException or JNIParameterExceptions will be thrown. The JNIException is the super class of those classes and therefor will catch both those exceptions. The JNIException will be caught by the Framework.

framework JNIParameterException.java When parameters are incorrectly accessed from a native (c, c++) module a JNIParameterException will be thrown. The Exception will be caught as a JNIException by the Framework.

framework Modulable.java All modules that can be run by the Framework must implement this interface. The Modulable interface only contains the method run().

framework ModuleData.java Abstract class that should be used as the super class of all Data classes. It has an implementation for each method of the the Data interface to make the task of writing a Data class easier. A Data class only has provide implementations for a limited number of methods in this class and to override the methods of interest.
This class provides three boolean variables called canLoad, canSave, and canDisplay with the value true and a boolean variable called canSaveStream with the value false. It also implements emtpy methods load(), save() (two overloaded versions) and display(). Data classes that can load, save or display their data need to override the appropriate methods. Data classes that do not want to provide methods for load, save or display need to override (or hide) the corresponding canLoad, canSave or canDisplay variable with one that has the value false, so the Framework will not call the corresponding load(), save() or display() method. Please note: the canLoad, canSave, canSaveStream and canDisplay variables must be public and static because they are meant to override a variable declared in an interface.
A method that wants to access one of these access variables in the Data class must use a reference which is of the same type as the Data class. If the reference is of the same type as this interface, the method will get the value declared here, the hidden value. If only a reference of the same type as this interface is available, the correct value can be retrieved using reflection.
This class is abstract to prevent it from instantiation.

framework ModuleException.java When a module is run and it can't be finished succesfully then a ModuleException will be thrown. This exception is not thrown when an error occurs in the java<->c interface. In that case JNIException's are thrown.

framework/awt BorderPanelGBL.java Extension on BorderPanel, allows user to set the gridbagconstraints.

framework/awt ButtonGBL.java Extension on Button, allows user to set the gridbagconstraints.

framework/awt CheckboxGBL.java Extension on Checkbox, allows user to set the gridbagconstraints.

framework/awt DisplayModuleDialog.java A Dialog for displaying Data-specific Components. If a Data class wants to display its Data, it creates a java.awt.Component that knows how to display the Data. The Component can be added to an instance of this class. This class creates a simple Dialog with a scrolling Panel, an Ok Button and a Save Button on the right bottom of the Dialog. The Component that will actually display the Data must be supplied to the constructor of this class by a Data class.

framework/awt FileField.java A component that can be used to specify the name of a file. The user can simply type a filename into a TextField, or he or she can select a file using a FileDialog that can be activated by a pressing a button in the FileField. FileField is a subclass of java.awt.Panel because it consists of more than one component.
If an application wants to be notified when the filename in the FileField changes (either by the user pressing return in the TextField or by getting a new selection from the FileDialog), it should implement the ActionListener interface and register the new listener to receive events from the FileField, by calling the addActionListener() method. The new filename is available to the application through the action event's command.
The FileField can also be queried for the current filename using method getFilename().

framework/awt FileFieldGBL.java Extension on FileField, allows user to set the gridbagconstraints.

framework/awt FontSelector.java Interface for classes that specify the Fonts the different parts of the Framework will use. If a part of the Framework needs to use a Font, it can ask a FontSelector which Font it must use. It does this by calling the getFont method with a property string as a parameter. The FontSelector uses the property to select a Font.

framework/awt GraphicsPanel.java A Panel that displays pictures.

framework/awt InteractiveModuleDialog.java The parent class of all Interactive Display modules. It creates a simple Dialog with a panel and several buttons below the panel. The panel is supposed to be filled by subclasses of this abstract class.

framework/awt LabelGBL.java Extension on Label, allows user to set the gridbagconstraints.

framework/awt ListBox.java /home/maarten/framework/bin/FirstDocComment: framework/awt/ListBox.java: no /** found

framework/awt MessagesDialog.java A TextDialog containing a that can be used to display messages to the user of the Framework. As an extra, it features a clear button.

framework/awt Rectangle.java A java.awt.Rectangle extended with a constructor that takes a descriptive string as its argument. The descriptive string consists of zero or more dimension type-value pairs. Each pair consists of a single character specifying the dimension (`x' for the x-coordinate, `y' for the y-coordinate, `w' for the witdh and `h' for the height of the Rectangle) and an integer number specifying the value. In addition to the normal whitespace characters, `,' is also a whitespace character. The characters specifying the dimension can be lower or upper case.

framework/awt TextAreaGBL.java Extension on TextArea, allows user to set the gridbagconstraints.

framework/awt TextDialog.java A Dialog containing a TextArea that can be used to display messages to the user of the Framework.

framework/awt TextFieldGBL.java Extension on TextField, allows user to set the gridbagconstraints.

framework/io DirectoryStore.java This class implements a Store for Directories using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

framework/io FileStore.java This class implements a Store for Files using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

java/awt NaiveCheckboxMenuItem.java This class produces a checkbox that represents a choice in a menu. Mostly copied from java.awt.CheckboxMenuItem. The state is represented in the menu by prepending "+" or "-" to the label of the MenuItem. This class is made because java.awt.CheckboxMenuItem does not work. On JDK1.1.3/Solaris, it does not receive ActionEvents or ItemEvents if it is part of a PopupMenu. This class must be part of the java.awt package because it needs to access variables from its superclasses that have package-level access. This class generates ItemEvents when the MenuItem is selected by the user. These ItemEvents can be listened to by registering a ItemListener to an instance of this class.

java/util Iterator.java An Iterator is designed to perform an action on every element of a collection. By using classes that implement this interface, client classes don't have to code loops, they only have to provide the action that is to be performed on each element. The actual iterating (initializing and incrementing the loop counter and checking if the loop terminates) is performed by classes that implement this interface. These iterator classes have to know about the structure of the collection that must be iterated over. The client classes provide the action to be done by overriding the action() method of an iterator class that can handle the specific collection that must be iterated over.

java/util VectorIterator.java This class provides an implementation of an Iterator that iterates over the contents of a java.util.Vector. Its doAll() method performs method action() on each element of the Vector, in no guaranteed order. Methods preAction(), action() and postAction() are empty. They must be implemented in subclasses of this class.

parameter BooleanParameter.java BooleanParameter is used to store the value of a boolean parameter.

parameter BooleanParameterType.java BooleanParameterType is used to store information describing a boolean parameter. It contains the default value of a parameter. This value is read from the Module Description File and can not be changed within the framework.

parameter IntegerParameter.java IntegerParameter is used to store the value of an integer parameter.

parameter IntegerParameterType.java IntegerParameterType is used to store information describing an integer parameter. It contains the default value, the minimum value and the maximum value of a parameter. These values are read from the Module Description File and can not be changed within the framework.

parameter MDFParameterException.java Thrown if a parameter value is invalied (for example, out of range).

parameter Parameter.java Parameters will be passed on to a module/program as an argument of the Modulable.run() method. This abstract class can contain all 4 different parameters: integer, reals (represented by doubles), strings and booleans. The parameters are read from the Module Description File and the parameter value can be set in EditModuleDialog.

parameter ParameterStore.java This class implements a Store for Parameters using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

parameter ParameterType.java ParameterType can contain all different parametersTypes. This abstract class can contain all 4 parameter types: integer types, real types, string types and boolean types. This class also contains the parameter name. This value is read from the Module Description File and can not be changed within the framework.

parameter RealParameter.java RealParameter is used to store the value of a real parameter.

parameter RealParameterType.java RealParameterType is used to store information describing a real parameter. It contains the default value, the minimum value and the maximum value of a parameter. These values are read from the Module Description File and can not be changed within the framework.

parameter StringParameter.java StringParameter is used to store the value of a string parameter.

parameter StringParameterType.java StringParameterType is used to store information describing a string parameter. It contains the default value of a parameter. These values are read from the Module Description File and can not be changed within the framework. This class extends the abstract class ParameterType

store DataStore.java This class implements a Store for objects that implement the framework.Data interface. The Store uses a java.util.Vector to store the elements. Unlike other Stores, a DataStore can contain null-elements. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.

store DataStoreIterator.java This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DataStore and a method action() that only works on a Data object. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.

store RawStorePrinter.java A StorePrinter that prints all elements in a `raw' DataStore: a DataStore which may contain null elements. The null elements are skipped by this StorePrinter. The normal StorePrinter can only work on DataStores that do not have null elements.
This class overrides method doAll(), so it won't call action() on null-elements.

store Store.java Class for storing certain elements which are used by the framework, for example, Modules, Connections and ModuleTypes. Objects that are to be stored in a Store must implement the interface StoreElement.

store StoreCounterPrinter.java A StoreIterator that prints all elements in a Store and also keeps track of the position in the store. The class is abstract so that subclasses of this class can define the action method. That action method is called from this method. (If the class is not abstract then the doAll method would call the action method defined here and not the action method in a subclass [that is what you want]).

store StoreElement.java All objects that can be stored in a Store class must implement this interface.

store StoreIterator.java The purpose of this interface is to make a new Iterator which will only work on classes that implement the Store interface. It will be certain that the Iterator works only on elements that implement the StoreElement interface. This interface should really only contain the methods doAll(Store) and action(StoreElement). It should not contain the methods doAll(Object) and action(Object) because, if used, the compiler cannot guarantee that the parameters used will conform to Store and StoreElement respectivily. Classes implementing this interface should report an error if doAll(Object) or action(Object) is called.

store StorePrinter.java A StoreIterator that prints all elements in a Store. Just like ModuleStoreIterator, it `disables' the methods doAll() and action() from the interface Iterator (inherited through StoreIterator), because they work on Objects, while this class is designed to work only on Stores.

Directory	Source file	Description
	AboutDialog.java	A basic extension of the java.awt.Dialog class, used to display general information about the Framework to the user when he or she selects the About menu item.
	AddConnectionResult.java	A class that implements an enumeration type that defines the values that can be returned by method Network.addConnection(). Each value of this enumeration type has a descriptive String. This String is returned by the method toString().
	ClassLoadResult.java	An enumeration type that defines the different errors that may occur when trying to load class file.
	CommandDataInputStream.java	Customized DataInputStream for the reading of Module Description Files.
	Commands.java	Class containing a set of constants used to identify the commands in the module description file.
	Connection.java	A connection between an InConnector and an OutConnector.
	ConnectionDisconnector.java	A ConnectionStoreIterator that disconnects all Connections from what they are connected to. This class overrides the doAll method. The doAll method in the superclass uses a java.util.Enumeration to traverse the ConnectionStore. The version of that method in this class traverses the ConnectionStore by using a for-loop. This is necessary because this class is supposed to disconnect the Connections, which means that they will be removed from the ConnectionStore. When elements are removed from the Store while traversing the store using a Enumeration, some elements are skipped. For efficiency, the ConnectionStore is traversed from the last element to the first.
	ConnectionStore.java	This class implements a Store for Connections using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
	ConnectionStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ConnectionStore and a method action() that only works on a Connection. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	Connector.java	Connectors represent the input and output of a module. Two Connectors of different modules, but of the same type, can be connected to each other using a Connection.
	ConnectorClearer.java	A ConnectorStoreIterator that removes data from each Connector.
	ConnectorCollector.java	A ModuleStoreIterator that collects all Connectors of all Modules in the Store.
	ConnectorDisconnector.java	A ConnectorStoreIterator that disconnects all Connectors from their Connections.
	ConnectorStore.java	This class implements a Store for Connectors using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
	ConnectorStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ConnectorStore and a method action() that only works on a Connector. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	DataCollector.java	A ConnectorStoreIterator that collects the data of all Connectors.
	DataDistributor.java	A ConnectorStoreIterator that distributes the Data in a specific DataStore over the Connectors in a ConnectorStore. Each element of the DataStore is given to the Connector in the ConnectorStore whose index corresponds to the index of the DataStore element.
	DataLoader.java	An InConnectorStoreIterator that loads data for each InConnector that has its `serveAsNetworkInput` flag set to `true` and does not already have data associated with it. NYI: in case of an error while loading the data, executing of the entire network should stop, so the error should be propagated through to the level of Network.run() somehow.
	DataSaver.java	An OutConnectorStoreIterator that asks the OutConnectors to save their Data.
	DataSetter.java	A ConnectionStoreIterator that gives all Connections a specified Data object using Connection.setData().
	DataType.java	The type of the data a module operates on.
	DataTypeChecker.java	A ConnectorStoreIterator that compares the types of the data of the Connectors in a ConnectorStore with the types of data in a specific DataStore.
	DataVisualisationCloser.java	/home/maarten/framework/bin/FirstDocComment: ./DataVisualisationCloser.java: no /** found
	DataVisualisationStore.java	This class implements a Store for instances of classes that implement the DataVisualisation interface. This Store uses java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
	DataVisualisationStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DataVisualisationStore and a method action() that only works on a DataVisualisation. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	DisplayComponent.java	Interface all classes used for the graphical user interface of the network must implement.
	DisplayConnection.java	[Insert purpose of class here] A DisplayConnection is normally one line, from the DisplayConnector for the OutConnector to the DisplayConnector for the InConnector. But if the DisplayConnector for the OutConnector is drawn higher (has smaller y-coordinate) than the DisplayConnector for the InConnector, the DisplayConnection consists of three lines. The first line is a line of fixed, short length from the DisplayConnector for the OutConnector that goes straight down. The third line is a line of fixed, short length from the DisplayConnector for the InConnector that goes straight up. The second line connects the first line to the third. Such a DisplayConnection is said to use fixed points.
	DisplayConnectionAdder.java	A ConnectionStoreIterator that adds all Connections to a DisplayNetwork.
	DisplayConnectionPainter.java	/home/maarten/framework/bin/FirstDocComment: ./DisplayConnectionPainter.java: no /** found
	DisplayConnectionStore.java	This class implements a Store for DisplayConnections using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
	DisplayConnectionStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DisplayConnectionStore and a method action() that only works on a DisplayConnection. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	DisplayConnector.java
	DisplayConnectorCreator.java	A ConnectorStoreIterator that creates a DisplayConnector for every Connector in the ConnectorStore.
	DisplayConnectors.java	/home/maarten/framework/bin/FirstDocComment: ./DisplayConnectors.java: no /** found
	DisplayMessage.java	/home/maarten/framework/bin/FirstDocComment: ./DisplayMessage.java: no /** found
	DisplayModule.java	/home/maarten/framework/bin/FirstDocComment: ./DisplayModule.java: no /** found
	DisplayModuleAdder.java	A ModuleStoreIterator that adds all Modules to a DisplayNetwork (the graphical view on the Network).
	DisplayModuleMain.java	the entire DisplayModule that this DisplayModuleMain is a part of.
	DisplayNetwork.java	An user interface component that shows a Network in a graphical way; the Modules are represented by boxes and the Connections by lines connecting the boxes.
	EditModuleParameters.java	Module parameters values and other module settings can be edited in EditModuleParameters. This dialog can be used to edit the parameters of a module. The parameters are read from the Module Description File and the values defined in this dialog are passed on to the Module.
	EndModuleSelector.java	A ModuleSelector which selects all end modules.
	Executer.java	The parent class of all classes that can schedule and execute the modules in a run path.
	FileAvailableChecker.java	This ConnectorStoreIterator checks if all Connectors in the Store answer `true` to their `fileAvailable()` method.
	FileLoadResult.java	An enumeration type that defines the different errors that may occur when a Data class tries to load a file.
	FileSaveResult.java	An enumeration type that defines the different errors that may occur when a Data class tries to save a file.
	FileStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a FileStore and a method action() that only works on a File. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	FlowDownConnectionStoreIterator.java	FlowDownConnectionStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on the connections of this StoreIterator and proceeds to underlaying modules via the inconnector of the connections. The module obtained from a connection is processed via the FlowDownConnectionStore- Iterator.
	FlowDownMarkModule.java	Marks modules. An instance of this class is passed as parameter to the FlowDownModuleStoreIterator that will walk through the network of modules. The methods defined in this class will be called every time a module is investigated.
	FlowDownModuleStoreIterator.java	FlowDownModuleStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on modules of this StoreIterator and proceeds to underlaying modules via the outconnectors by using the FlowDownOutConnectorStoreIterator.
	FlowDownOutConnectorStoreIterator.java	FlowDownOutConnectorStoreIterator is one of three classes that can be used to walk (depth first) through a network of modules. This class uses the action method on out connectors of this StoreIterator and proceeds to underlaying modules via the connections defined in the out connector by using the FlowDownConnectionStoreIterator.
	FlowIteration.java	An abstract class that defines methods that are called in the FlowDown- ModuleStoreIterator clas. The methods declared here can be defined by sub classes of this abstract class (i.e. MarkModule).
	FlowUpInConnectorStoreIterator.java	FlowUpInConnectorStoreIterator is one of two classes that can be used to walk (depth first from bottom to top) through a network of modules. This class uses the action method on in connectors of this StoreIterator and proceeds to the module above via the connection defined in the in connector.
	FlowUpMarkModule.java	Marks modules. An instance of this class is (for example) passed as parameter to the FlowUpModuleStoreIterator that will walk through the network of modules. The method defined in this class will be called every time a module is investigated.
	FlowUpModuleStoreIterator.java	FlowUpModuleStoreIterator is one of two classes that can be used to walk (depth first bottom-up) through a network of modules. This class uses the action method on modules of this StoreIterator and proceeds to modules above via the inconnectors by using the FlowUpInConnectorStoreIterator.
	FontSelector.java	An implementation of interface framework.awt.FontSelector. This class serves as the interface between the Framework properties and parts of the Framework that need Fonts. This class can return a Font (using method getFont()) for a specific Framework property and knows what to do if the property does not exist.
	Framework.java	The main class of the framework. This class contains data that is global to the framework. It also contains the `main()` method.
	GraphicalViewFrame.java	A rectangle specifying default values for the position and size of the Frame. These values are only used if the Frame cannot find a position and size in the properties of the Framework.
	HashtableInfoHandler.java	/home/maarten/framework/bin/FirstDocComment: ./HashtableInfoHandler.java: no /** found
	HelpTexts.java	A store for keeping the help texts. The help texts are referenced using a String called the `subject'. With a subject, you can retrieve the corresponding help text. This class contains the mapping from subjects to help text files. This class also buffers the help texts in a Hashtable.
	HelpViewer.java	The abstract super class of all help text viewer classes. It gets its texts from a HelpTexts instance that is passed to the constructor of this class. This way, the texts that are displayed are independent of the way they are displayed, so the same texts can be used in several HelpViewers specialized in several contexts.
	HelpViewerDialog.java	A subclass of HelpViewer that shows the help texts in a TextDialog.
	InConnector.java	Inconnectors are those connectors of a module that provide the input for a module.
	InConnectorCollector.java	A ConnectorCollector that collects all InConnectors of all Modules in the Store.
	InConnectorMarker.java	A ConnectorStoreIterator that sets the `serveAsNetworkInput` flag of a set of InConnectors.
	InConnectorSelector.java	An abstract InConnectorStoreIterator that can select InConnectors that satisfy a specified condition.
	InConnectorStore.java	This subclass of ConnectorStore implements a Store for InConnectors
	InConnectorStoreIterator.java	This class is an extension of ConnectorStoreIterator. This class contains a method doAll() that only works on an InConnectorStore and a method action() that only works on an InConnector. The methods doAll() and action() inherited from ConnectorStoreIterator are `disabled' in this class: when called, they only generate an exception.
	InfluencesModule.java	Finds out if a module A is influenced by a module B. That is if a module A receives data from module B then it is influenced by module A. This class is (for example) used when a loop check is performed in addConnection of Network. The methods followAction (that marks the module) and modulePostCondition are defined in the abstract class MarkModule.
	InfoHandler.java	/home/maarten/framework/bin/FirstDocComment: ./InfoHandler.java: no /** found
	InvalidInternalStateException.java	Thrown when the program notices that the internal datastructures are invalid.
	ListView.java	An user interface component that shows a Network by means of two lists; one containing the Modules and one containing the Connections between the Modules. This class can be used as a view in the Model-View-Controller paradigm, because it implements Observer.
	MDFConnectorException.java	Thrown when an error occurs while reading a Connector from a Module Description File.
	MakeModules.java	Automatically generate the intermediate java and C(++) files necessary for calling a C module. Furthermore this class contains a method that gives the module developer directions of what to do after the intermediate files are generated.
	MarkModule.java	Abstract class that marks modules. An instances of a super class of this class can be passed on as parameter to the either the FlowUpModuleStore- Iterator or FlowDownModuleStoreIterator that will walk up resp. down through the network of modules. The methods defined in this class will be called every time a module is investigated. (Some of the) methods defined here are overrided in sub classes of this class (i.e modulePostCondition is defined in the classes FlowUpMarkModule and FlowDownMarkModule in the class InfluencesModule.
	MarkedModuleSelector.java	A ModuleSelector which selects all marked modules.
	ModelEvent.java	/home/maarten/framework/bin/FirstDocComment: ./ModelEvent.java: no /** found
	ModelEventId.java	/home/maarten/framework/bin/FirstDocComment: ./ModelEventId.java: no /** found
	Module.java	An occurrance of a module in a network.
	ModuleClearer.java	A ModuleStoreIterator that removes the Data stored at all Modules.
	ModuleGeneratorDialog.java	Automatically generate the intermediate java and C(++) files necessary for calling a C module. Furthermore this class contains a method that gives the module developer directions of what to do after the intermediate files are generated.
	ModulePreparer.java	A ModuleStoreIterator that prepares all Modules for running by calling their `prepareToRun()` method.
	ModuleRemover.java	A ModuleStoreIterator that removes the Modules it iterates over from a specified ModuleStore.
	ModuleRunner.java	A ModuleStoreIterator that runs all Modules by calling their `run()` method.
	ModuleSelector.java	An abstract ModuleStoreIterator that can select Modules that satisfy a specified condition.
	ModuleStore.java	This class implements a Store for Modules using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
	ModuleStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a ModuleStore and a method action() that only works on a module. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
	ModuleType.java	Class containing the information that several occurrances of the same Module have in common.
	Network.java	A class describing a network.
	NetworkFrame.java	This simple extension of the java.awt.Frame class contains all the elements necessary to act as the main window of an application.
	NetworkInputSelector.java	An InConnectorSelector that selects the InConnectors that serve as input for a collection of modules. These are the InConnectors that do not receive their input from other modules in the collection because they have no connection to modules in the collection. They either have no connection at all, or are connected to a module that is not in the collection.
	NetworkLayout.java	/home/maarten/framework/bin/FirstDocComment: ./NetworkLayout.java: no /** found
	NetworkObservable.java	This method is overridden so notification for objects that are not part of the model can be suppressed. This is a temporary fix. It should be replaced by view-specific information storage in the model or some other scheme or division of the model in various sub-models. Notifications for Modules (or their Connectors) are suppressed if the Module is not part of a model.
	NetworkState.java	An enumeration type that defines the different states a Network may be in.
	Notifiable.java	/home/maarten/framework/bin/FirstDocComment: ./Notifiable.java: no /** found
	OutConnector.java	Outconnectors are those connectors of a module that provide the output of a module.
	OutConnectorCollector.java	A ConnectorCollector that collects all OutConnectors of all Modules in the Store.
	OutConnectorStore.java	This subclass of ConnectorStore implements a Store for OutConnectors
	OutConnectorStoreIterator.java	This class is an extension of ConnectorStoreIterator. This class contains a method doAll() that only works on an OutConnectorStore and a method action() that only works on an OutConnector. The methods doAll() and action() inherited from ConnectorStoreIterator are `disabled' in this class: when called, they only generate an exception.
	QuitDialog.java	A basic extension of the java.awt.Dialog class, used to ask the user for confirmation when he or she selects the Exit menu item.
	ResultHandler.java	/home/maarten/framework/bin/FirstDocComment: ./ResultHandler.java: no /** found
	ResultSelector.java	/home/maarten/framework/bin/FirstDocComment: ./ResultSelector.java: no /** found
	RunnableModuleSelector.java	This `ModuleSelector` subclass selects all `Module`s that have all their input available in memory or on disk.
	SelectBasenameDialog.java	A basic extension of the java.awt.Dialog class that is used to select basenames.
	SequentialExecuter.java	Being a subclass of `Executer`, this class can schedule and execute a set of `Module`s. It executes them sequentially, one after another.
	StartModuleSelector.java	A ModuleSelector which selects all start modules.
	StoreAppender.java	A StoreIterator that adds all elements of a Store to another Store. Just like ModuleStoreIterator, it `disables' the methods doAll() and action() from the interface Iterator (inherited through StoreIterator), because they work on Objects, while this class is designed to work only on Stores.
	Timer.java	notification (`true`) or if it should continue to send notifications until it is stopped (`false`).
	UnMarkModule.java	Unmarks the modules that are marked. An instance of this class is passed as parameter to the FlowDownModuleStoreIterator that will walk through the network of modules. The methods defined in this class will be called every time a module is investigated.
	ViewSelector.java	Selects the view. If there is more than 1 view, the first one is chosen. The display can return an object (containing display information) to the 'requester' by calling the addInfo method.
Module	ImageData.java	ImageData is the java class that contains pictures. If a gif is read from disk in java the data is stored in an ImageData object.
Module/picture	FileInput.java	FileInput is a class that is used for the data input.
Module/picture	GifEncoder.java	Write out an image as a GIF. Fetch the software. Fetch the entire Acme package.
Module/picture	ImageEncoder.java	Abstract class for writing out an image. A framework for classes that encode and write out an image in a particular file format. This provides a simplified rendition of the ImageConsumer interface. It always delivers the pixels as ints in the RGBdefault color model. It always provides them in top-down left-right order. If you want more flexibility you can always implement ImageConsumer directly. Fetch the software. Fetch the entire Acme package.
Module/picture	ImageLoader.java	ImageLoader is the superclass for various image loaders. In particular the BMP and TGA ImageLoader classes. Classes from http://village.ch/~schoen/
Module/picture	IntHashtable.java	A Hashtable that uses ints as the keys. Use just like java.util.Hashtable, except that the keys must be ints. This is much faster than creating a new Integer for each access. Fetch the software. Fetch the entire Acme package.
Module/picture	JpegEncoder.java	Write out an image as a JPEG. DOESN'T WORK YET. Fetch the software. Fetch the entire Acme package.
Module/picture	NoSuchLoaderException.java	An exception indicated that file format was wrong
Module/picture	PpmEncoder.java	Write out an image as a PPM. Writes an image onto a specified OutputStream in the PPM file format. Fetch the software. Fetch the entire Acme package.
Module/picture	UnsupportedFormatException.java	An exception indicated that file format is not supported
Module/picture	WrongFileFormatException.java	An exception indicated that file format was wrong
framework	Data.java	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. Among other things, this interface contains methods for loading and saving the Data and displaying the Data to the user of the Framework. These methods are called load, save and display (save is overloaded). Not every Data class has to provide this functionality. For each of these methods, this interface contains a corresponding boolean variable which indicates wether a particular Data class can load, save or display its data. Before any of these methods are used by the Framework, it checks the corresponding boolean variable and only calls the method if the variable has the value `true`. These variables are called canLoad, canSave, canSaveStream and canDisplay. If a Data class does not provide functionality for loading, saving or displaying its data, it still has to provide an implementation for each of these methods, in order to implement this interface. The Data class can give an empty implementation and set the corresponding access variable to `false`. The easiest way to create a Data class is to extend class ModuleData. This abstract class implements the Data interface and has useful implementations for most of the methods from the Data interface. The access variables, canLoad, canSave, canSaveStream and canDisplay are declared in this interface with a default value which is `false`. Data classes that want to change this value have to contain a public and static boolean variable with the same name. Such a variable hides the variable declared in this interface. A method that wants to access one of these access variables in the Data class must use a reference which is of the same type as the Data class. If the reference is of the same type as this interface, the method will get the value declared here, the hidden value. If only a reference of the same type as this interface is available, the correct value can be retrieved using reflection.
framework	DataException.java	A DataException will occur when: Framework data types are improperly defined. For example when a data type has a save method, but no save tags are defined. Framework data can not be saved or loaded.
framework	DataVisualisation.java	/home/maarten/framework/bin/FirstDocComment: framework/DataVisualisation.java: no /** found
framework	Debug.java	Help with printing of debug information. Debug information can be printed with method println(). Printing debug information can be enabled or disabled by using the system property "debug".
framework	FrameworkAgent.java	The FrameworkAgent is the Framework's run-time "representative" towards the Modules, Data classes and other classes external to the Framework. The FrameworkAgent can be used to query the Framework for some of its variables that may be interesting to external classes, like its MessagesDialog and its FontSelector.
framework	JNIDataException.java	When data is incorrectly accessed from a native (c, c++) module a JNIDataException will be thrown. The Exception will be caught as an JNIException by the Framework.
framework	JNIException.java	When data or parameters are incorrectly accessed from a native (c, c++) module JNIDataException or JNIParameterExceptions will be thrown. The JNIException is the super class of those classes and therefor will catch both those exceptions. The JNIException will be caught by the Framework.
framework	JNIParameterException.java	When parameters are incorrectly accessed from a native (c, c++) module a JNIParameterException will be thrown. The Exception will be caught as a JNIException by the Framework.
framework	Modulable.java	All modules that can be run by the Framework must implement this interface. The Modulable interface only contains the method run().
framework	ModuleData.java	Abstract class that should be used as the super class of all Data classes. It has an implementation for each method of the the Data interface to make the task of writing a Data class easier. A Data class only has provide implementations for a limited number of methods in this class and to override the methods of interest. This class provides three boolean variables called canLoad, canSave, and canDisplay with the value `true` and a boolean variable called canSaveStream with the value `false`. It also implements emtpy methods load(), save() (two overloaded versions) and display(). Data classes that can load, save or display their data need to override the appropriate methods. Data classes that do not want to provide methods for load, save or display need to override (or hide) the corresponding canLoad, canSave or canDisplay variable with one that has the value `false`, so the Framework will not call the corresponding load(), save() or display() method. Please note: the canLoad, canSave, canSaveStream and canDisplay variables must be public and static because they are meant to override a variable declared in an interface. A method that wants to access one of these access variables in the Data class must use a reference which is of the same type as the Data class. If the reference is of the same type as this interface, the method will get the value declared here, the hidden value. If only a reference of the same type as this interface is available, the correct value can be retrieved using reflection. This class is abstract to prevent it from instantiation.
framework	ModuleException.java	When a module is run and it can't be finished succesfully then a ModuleException will be thrown. This exception is not thrown when an error occurs in the java<->c interface. In that case JNIException's are thrown.
framework/awt	BorderPanelGBL.java	Extension on BorderPanel, allows user to set the gridbagconstraints.
framework/awt	ButtonGBL.java	Extension on Button, allows user to set the gridbagconstraints.
framework/awt	CheckboxGBL.java	Extension on Checkbox, allows user to set the gridbagconstraints.
framework/awt	DisplayModuleDialog.java	A Dialog for displaying Data-specific Components. If a Data class wants to display its Data, it creates a java.awt.Component that knows how to display the Data. The Component can be added to an instance of this class. This class creates a simple Dialog with a scrolling Panel, an Ok Button and a Save Button on the right bottom of the Dialog. The Component that will actually display the Data must be supplied to the constructor of this class by a Data class.
framework/awt	FileField.java	A component that can be used to specify the name of a file. The user can simply type a filename into a TextField, or he or she can select a file using a FileDialog that can be activated by a pressing a button in the FileField. FileField is a subclass of java.awt.Panel because it consists of more than one component. If an application wants to be notified when the filename in the FileField changes (either by the user pressing return in the TextField or by getting a new selection from the FileDialog), it should implement the ActionListener interface and register the new listener to receive events from the FileField, by calling the addActionListener() method. The new filename is available to the application through the action event's command. The FileField can also be queried for the current filename using method getFilename().
framework/awt	FileFieldGBL.java	Extension on FileField, allows user to set the gridbagconstraints.
framework/awt	FontSelector.java	Interface for classes that specify the Fonts the different parts of the Framework will use. If a part of the Framework needs to use a Font, it can ask a FontSelector which Font it must use. It does this by calling the getFont method with a property string as a parameter. The FontSelector uses the property to select a Font.
framework/awt	GraphicsPanel.java	A Panel that displays pictures.
framework/awt	InteractiveModuleDialog.java	The parent class of all Interactive Display modules. It creates a simple Dialog with a panel and several buttons below the panel. The panel is supposed to be filled by subclasses of this abstract class.
framework/awt	LabelGBL.java	Extension on Label, allows user to set the gridbagconstraints.
framework/awt	ListBox.java	/home/maarten/framework/bin/FirstDocComment: framework/awt/ListBox.java: no /** found
framework/awt	MessagesDialog.java	A TextDialog containing a that can be used to display messages to the user of the Framework. As an extra, it features a clear button.
framework/awt	Rectangle.java	A java.awt.Rectangle extended with a constructor that takes a descriptive string as its argument. The descriptive string consists of zero or more dimension type-value pairs. Each pair consists of a single character specifying the dimension (`x' for the x-coordinate, `y' for the y-coordinate, `w' for the witdh and `h' for the height of the Rectangle) and an integer number specifying the value. In addition to the normal whitespace characters, `,' is also a whitespace character. The characters specifying the dimension can be lower or upper case.
framework/awt	TextAreaGBL.java	Extension on TextArea, allows user to set the gridbagconstraints.
framework/awt	TextDialog.java	A Dialog containing a TextArea that can be used to display messages to the user of the Framework.
framework/awt	TextFieldGBL.java	Extension on TextField, allows user to set the gridbagconstraints.
framework/io	DirectoryStore.java	This class implements a Store for Directories using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
framework/io	FileStore.java	This class implements a Store for Files using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
java/awt	NaiveCheckboxMenuItem.java	This class produces a checkbox that represents a choice in a menu. Mostly copied from java.awt.CheckboxMenuItem. The state is represented in the menu by prepending "+" or "-" to the label of the MenuItem. This class is made because java.awt.CheckboxMenuItem does not work. On JDK1.1.3/Solaris, it does not receive ActionEvents or ItemEvents if it is part of a PopupMenu. This class must be part of the java.awt package because it needs to access variables from its superclasses that have package-level access. This class generates ItemEvents when the MenuItem is selected by the user. These ItemEvents can be listened to by registering a ItemListener to an instance of this class.
java/util	Iterator.java	An Iterator is designed to perform an action on every element of a collection. By using classes that implement this interface, client classes don't have to code loops, they only have to provide the action that is to be performed on each element. The actual iterating (initializing and incrementing the loop counter and checking if the loop terminates) is performed by classes that implement this interface. These iterator classes have to know about the structure of the collection that must be iterated over. The client classes provide the action to be done by overriding the `action()` method of an iterator class that can handle the specific collection that must be iterated over.
java/util	VectorIterator.java	This class provides an implementation of an Iterator that iterates over the contents of a java.util.Vector. Its `doAll()` method performs method `action()` on each element of the Vector, in no guaranteed order. Methods `preAction()`, `action()` and `postAction()` are empty. They must be implemented in subclasses of this class.
parameter	BooleanParameter.java	BooleanParameter is used to store the value of a boolean parameter.
parameter	BooleanParameterType.java	BooleanParameterType is used to store information describing a boolean parameter. It contains the default value of a parameter. This value is read from the Module Description File and can not be changed within the framework.
parameter	IntegerParameter.java	IntegerParameter is used to store the value of an integer parameter.
parameter	IntegerParameterType.java	IntegerParameterType is used to store information describing an integer parameter. It contains the default value, the minimum value and the maximum value of a parameter. These values are read from the Module Description File and can not be changed within the framework.
parameter	MDFParameterException.java	Thrown if a parameter value is invalied (for example, out of range).
parameter	Parameter.java	Parameters will be passed on to a module/program as an argument of the Modulable.run() method. This abstract class can contain all 4 different parameters: integer, reals (represented by doubles), strings and booleans. The parameters are read from the Module Description File and the parameter value can be set in EditModuleDialog.
parameter	ParameterStore.java	This class implements a Store for Parameters using java.util.Vector. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
parameter	ParameterType.java	ParameterType can contain all different parametersTypes. This abstract class can contain all 4 parameter types: integer types, real types, string types and boolean types. This class also contains the parameter name. This value is read from the Module Description File and can not be changed within the framework.
parameter	RealParameter.java	RealParameter is used to store the value of a real parameter.
parameter	RealParameterType.java	RealParameterType is used to store information describing a real parameter. It contains the default value, the minimum value and the maximum value of a parameter. These values are read from the Module Description File and can not be changed within the framework.
parameter	StringParameter.java	StringParameter is used to store the value of a string parameter.
parameter	StringParameterType.java	StringParameterType is used to store information describing a string parameter. It contains the default value of a parameter. These values are read from the Module Description File and can not be changed within the framework. This class extends the abstract class ParameterType
store	DataStore.java	This class implements a Store for objects that implement the framework.Data interface. The Store uses a java.util.Vector to store the elements. Unlike other Stores, a DataStore can contain `null`-elements. Specific class of meant-to-be-generic class java.util.Vector. This class really should be a subclass of java.util.Vector, but most members of java.util.Vector are final.
store	DataStoreIterator.java	This class is an extension of VectorIterator that implements StoreIterator instead of Iterator. This class contains a method doAll() that only works on a DataStore and a method action() that only works on a Data object. The methods doAll() and action() inherited from VectorIterator (and which are part of interface Iterator) and the methods doAll() and action() from StoreIterator are `disabled' in this class: when called, they only generate an exception.
store	RawStorePrinter.java	A StorePrinter that prints all elements in a `raw' DataStore: a DataStore which may contain `null` elements. The `null` elements are skipped by this StorePrinter. The normal StorePrinter can only work on DataStores that do not have `null` elements. This class overrides method doAll(), so it won't call action() on null-elements.
store	Store.java	Class for storing certain elements which are used by the framework, for example, Modules, Connections and ModuleTypes. Objects that are to be stored in a Store must implement the interface StoreElement.
store	StoreCounterPrinter.java	A StoreIterator that prints all elements in a Store and also keeps track of the position in the store. The class is abstract so that subclasses of this class can define the action method. That action method is called from this method. (If the class is not abstract then the doAll method would call the action method defined here and not the action method in a subclass [that is what you want]).
store	StoreElement.java	All objects that can be stored in a Store class must implement this interface.
store	StoreIterator.java	The purpose of this interface is to make a new Iterator which will only work on classes that implement the Store interface. It will be certain that the Iterator works only on elements that implement the StoreElement interface. This interface should really only contain the methods doAll(Store) and action(StoreElement). It should not contain the methods doAll(Object) and action(Object) because, if used, the compiler cannot guarantee that the parameters used will conform to Store and StoreElement respectivily. Classes implementing this interface should report an error if doAll(Object) or action(Object) is called.
store	StorePrinter.java	A StoreIterator that prints all elements in a Store. Just like ModuleStoreIterator, it `disables' the methods doAll() and action() from the interface Iterator (inherited through StoreIterator), because they work on Objects, while this class is designed to work only on Stores.

ISFER

This page was last modified on .