Class Module

java.lang.Object
   |
   +----Module

class Module

extends Object

implements StoreElement

Version:

$Revision: 1.81 $

See Also:

ModuleType, Network

endModule

inConnectors

marked

A module can be marked for several reasons.

messagesDialog

moduleCode

An instance of the class that implements the algoritm of the module.

moduleLoadResult

The result of the last try to load a class file by prepareToRun().

moduleType

network

outConnectors

parameters

partOfModel

This boolean indicates if the Module has been added to the model of the Model-View-Controller triad of the program.

startModule

Module(Network, String)

checkOutput(DataStore)

Check if the Data objects in a DataStore have the types for the OutConnectors described in the module description file of this module.

clearData()

Remove the Data of all Connectors.

disconnect()

Disconnect all Connections to or from this Module.

displayError()

displayOutput()

Ask all OutConnectors to display their Data.

distributeOutput(DataStore)

Distribute the data in a specific DataStore over the OutConnectors of the module.

finalize()

getCodeClassFilename()

getDescriptiveString()

getInConnector(int)

getInConnectors()

Return the InConnectors of the Module.

getMDFileName()

getModuleDescription()

getName()

getNetwork()

getNrOfInConnectors()

getNrOfOutConnectors()

getNrOfParameters()

getOutConnector(int)

getOutConnectors()

Return the OutConnectors of the Module.

getParameter(int)

Get a single parameter from the parameter store.

getParameters()

Return the Parameters of the Module.

getType()

isEndModule()

isMarked()

isStartModule()

markIt()

prepareToRun()

This method creates an instance of the class with the code for the Module.

readMDFile(String)

Read the Module Description File from disk.

resultText(int)

run()

saveOutput()

Ask all OutConnectors to save their Data.

setEndModule(boolean)

setStartModule(boolean)

toString()

unMarkIt()

 private Network network

 private MessagesDialog messagesDialog

 private ModuleType moduleType

 private InConnectorStore inConnectors

 private OutConnectorStore outConnectors

 private ParameterStore parameters

 private boolean startModule

 private boolean endModule

 private Modulable moduleCode

An instance of the class that implements the algoritm of the module. This object is used when the method run() of this module is called. It is setup by method prepareToRun().

After use this reference should be set to null because the object cannot be garbage collected while there are still references to it. When all instances of a class are gone, the class itself can be reloaded if there is a new version of it.

See Also:

run, prepareToRun

 private ClassLoadResult moduleLoadResult

The result of the last try to load a class file by prepareToRun(). It is set by prepareToRun() and used by displayError().

See Also:

prepareToRun, displayError

 private boolean marked

A module can be marked for several reasons. Examples of this are: When the runpath of the network is determined to indicate what modules are in the runpath or when the network is checked for loops.

 boolean partOfModel

This boolean indicates if the Module has been added to the model of the Model-View-Controller triad of the program. If it has been added, the Views must be notified if something in the Module changes. If it has not been added, the Views must not be notified because the Views should only get events on objects that are part of the model. This boolean serves as a temporary fix to make it possible to load Networks. When storing view-specific information in the model is implemented, this can change and this variable can be removed. The NetworkObservable uses this boolean to suppress any notifications of the Views for Modules (or its Connectors) which are not part of a model. This boolean is set by the makeModule() and addModule() methods of class Network.

 Module(Network network,
        String MDFileName)

 String getMDFileName()

 String getName()

 String getModuleDescription()

 String getCodeClassFilename()

 InConnector getInConnector(int conNr)

 OutConnector getOutConnector(int conNr)

 public Network getNetwork()

 int getNrOfInConnectors()

 int getNrOfOutConnectors()

 void setStartModule(boolean status)

 void setEndModule(boolean status)

 boolean isStartModule()

 boolean isEndModule()

 public void markIt()

 public void unMarkIt()

 public boolean isMarked()

 Parameter getParameter(int parameterNr)

Get a single parameter from the parameter store.

Parameters:

parameterNr - The number of the parameter that is requested.

 int getNrOfParameters()

 boolean readMDFile(String MDFileName)

Read the Module Description File from disk. The module description file is read from disk and stored in the interal representation.

 public String toString()

Overrides:

toString in class Object

 public boolean prepareToRun()

This method creates an instance of the class with the code for the Module. References to this instance should be set to null after use because the instance and its class cannot be garbage collected otherwise.

 public void run()

 public void finalize() throws Throwable

Throws: Throwable

never.

Overrides:

finalize in class Object

 public void displayError()

 public InConnectorStore getInConnectors()

Return the InConnectors of the Module.

See Also:

InConnectorStore

 public OutConnectorStore getOutConnectors()

Return the OutConnectors of the Module.

See Also:

OutConnectorStore

 public ParameterStore getParameters()

Return the Parameters of the Module.

See Also:

ParameterStore

 private boolean checkOutput(DataStore output)

Check if the Data objects in a DataStore have the types for the OutConnectors described in the module description file of this module.

Parameters:

output - the DataStore containing the data to be checked.

Returns:

true if the data can be accepted as correct output of this module, false otherwise.

 private void distributeOutput(DataStore output)

Distribute the data in a specific DataStore over the OutConnectors of the module.

Parameters:

output - the DataStore containing the data to be distributed.

 void clearData()

Remove the Data of all Connectors.

 private void saveOutput()

Ask all OutConnectors to save their Data. They will do this if necessary.

 private DataVisualisationStore displayOutput()

Ask all OutConnectors to display their Data. They will do this if necessary.

 String resultText(int result)

 ModuleType getType()

Returns:

a reference to the ModuleType representing the type of this Module.

 void disconnect()

Disconnect all Connections to or from this Module.

 public String getDescriptiveString()

Returns:

a String that describes the Module in such a way that it can be used in load and save network.

See Also:

loadNetwork, saveNetwork