edu.iu.iv.modeling.tarl.author
Interface AuthorDatabase

All Known Implementing Classes:

DefaultAuthorDatabase

public interface AuthorDatabase

This interface defines the AuthorDatabase which is used to store all the Authors ever produced in the system. The interface is responsible for operations like initializing the database, adding a new Author to the database, iterating through each Author of the database, removing all the Authors from the database, etc.
Apart from these functions, the major responsibility of the interface is to tag each Author with a unique identifier which distinguishes it from other Authors.

Author:

Jeegar T Maru

See Also:

AuthorGroup, AuthorManager

Method Summary

void	addAuthor(Topic topic) Adds a new Author to the database with the specified Topic.
void	addAuthor(Topic topic, int maximumAge) Adds a new Author to the database with the specified Topic and maximum age.
AuthorGroup	getAuthors() Returns all the Authors in the database
Author	getNextAuthor() Returns the next Author in the database while iteration
boolean	hasMoreAuthors() Tests whether the database has more Authors for iteration
void	removeAll() Removes all the Authors from the database
void	resetSearchIndex() Resets the Search Index to the start of the list of Authors.
int	size() Returns the number of Authors in the database

Method Detail

addAuthor

public void addAuthor(Topic topic)
               throws TarlException

Adds a new Author to the database with the specified Topic. The system should store the Author for retreival in the future. The maximum age of the author is assumed to be infinite.

Parameters:

topic - Specifies the topic that the author belongs to

Throws:

TarlException - if the specified parameters are insufficient to construct an author

addAuthor

public void addAuthor(Topic topic,
                      int maximumAge)
               throws TarlException

Adds a new Author to the database with the specified Topic and maximum age. The system should store the Author for retreival in the future.

Parameters:

topic - Specifies the topic that the author belongs to

maximumAge - Specifies the maximum age of the author

Throws:

TarlException - if the specified parameters are insufficient to construct an author

getAuthors

public AuthorGroup getAuthors()

Returns all the Authors in the database

Returns:

the group of authors in the database

size

public int size()

Returns the number of Authors in the database

Returns:

the number of authors in the database

resetSearchIndex

public void resetSearchIndex()

Resets the Search Index to the start of the list of Authors. This function is called just before iterating through the Authors.

hasMoreAuthors

public boolean hasMoreAuthors()

Tests whether the database has more Authors for iteration

Returns:

true, if the database has more authors to visit

getNextAuthor

public Author getNextAuthor()
                     throws java.util.NoSuchElementException

Returns the next Author in the database while iteration

Returns:

the next author in the database

Throws:

java.util.NoSuchElementException - if the database has no more authors

removeAll

public void removeAll()

Removes all the Authors from the database