edu.iu.iv.modeling.tarl.topic
Interface TopicManager

All Known Implementing Classes:

DefaultTopicManager

public interface TopicManager

This interface defines all the high-level functions related to Topics. The TarlExecuter solely uses this interface to deal with the Topic environment. Some of the functions related to topics are initializing the topics environment, retrieving a random topic from the database and cleaning up the topic environment.

Author:

Jeegar T Maru

See Also:

TopicDatabase

Method Summary

void	cleanUpTopic() Cleans up the Topic environment.
Topic	getRandomTopic() Returns a random Topic from the database
TopicGroup	getTopics() Returns the group of all the Topics in the system
void	initializeTopics(TopicParameters topicParameters) Initializes the Topic environment to enable various operations on the Topics.

Method Detail

initializeTopics

public void initializeTopics(TopicParameters topicParameters)

Initializes the Topic environment to enable various operations on the Topics. This function should be called before calling any other function in TopicManager.

Parameters:

topicParameters - Specifies the model parameters related to topics

getRandomTopic

public Topic getRandomTopic()

Returns a random Topic from the database

Returns:

a random topic

getTopics

public TopicGroup getTopics()

Returns the group of all the Topics in the system

Returns:

Group of all the topics

cleanUpTopic

public void cleanUpTopic()

Cleans up the Topic environment. It is responsible for freeing up resources that the Topic environment has used for its execution.