edu.iu.iv.modeling.tarl.main
Interface TarlExecuter

All Known Implementing Classes:

DefaultTarlExecuter

public interface TarlExecuter

This interface defines the function of the TarlExecuter. The TarlExecuter is responsible for the providing the core functions for the Tarl model such as adding an author/publication, publishing for the current year, deactivating an author, terminating the current year, generating output, etc.

Author:

Jeegar T Maru

See Also:

TarlHelper

Method Summary

void	cleanUpSystem() Cleans up the system.
void	initializeModel(ExecuterParameters executerParameters, java.io.File agingFunctionFile) Initializes itself with the corresponding input parameters.
void	producePublications() Produces Publications for the current year.
void	terminateCurrentYear() Terminates the current year for the system.
void	writeOutputFiles(java.lang.String outputFolder) Writes the Output Files to the file system

Method Detail

initializeModel

public void initializeModel(ExecuterParameters executerParameters,
                            java.io.File agingFunctionFile)
                     throws TarlException

Initializes itself with the corresponding input parameters. These parameters are used while carrying out the functions so that they need not be provided again and again. This function should also initialize any of the modules that the TarlExecuter is relying on. This function should be called before calling any other function in the interface.

Parameters:

executerParameters - Specifies the executer parameters of the model

Throws:

TarlException - if the constraints of the model are violated

producePublications

public void producePublications()
                         throws TarlException

Produces Publications for the current year. The TarlExecuter should choose the parameters for producing the publications based on the initialization values that it was supplied with.

Throws:

TarlException - if the constraints of the model are violated

terminateCurrentYear

public void terminateCurrentYear()
                          throws TarlException

Terminates the current year for the system. The TarlExecuter should update the system to indicate that the current year has terminated.

Throws:

TarlException - if the new authors cannot be instantiated

writeOutputFiles

public void writeOutputFiles(java.lang.String outputFolder)

Writes the Output Files to the file system

Parameters:

outputFolder - Specifies the name of the output folder

cleanUpSystem

public void cleanUpSystem()

Cleans up the system. This function frees all the resources that the system has consumed while running.