edu.iu.iv.modeling.tarl.publication
Interface Publication

All Known Implementing Classes:

DefaultPublication

public interface Publication

This interface defines a Publication by defining the necessary functions it should support. The Publication is used to represent the produce by an Author. The minimal attributes of a Publication are :

• a non-null year of Publication which has an equivalent integer representation
• a non-null topic that the Publication belongs to which has an equivalent TopicInterface representation
• a non-null group of authors who have collaborated for producing the Publication which has an equivalent AuthorGroupInterface representation
• a group of citations for the Publication which has an equivalent PublicationGroupInterface. The group of citations could be null which is usually used to represent Publications produced at the start of the model.

All Publications should also support an identification tag that the PublicationDatabase provides to enable other classes to distinguish between different Publications.

Author:

Jeegar T Maru

See Also:

PublicationDatabase, Topic, AuthorGroup, PublicationGroup

Method Summary

boolean	equals(Publication publicationInterface) Tests whether the current Publication is the same as the specified one.
AuthorGroup	getAuthors() Returns the Authors who have collaborated for the Publication
PublicationGroup	getCitations() Returns the citations of the Publication
int	getId() Returns the unique identifier assigned by the PublicationDatabaseInterface of the Publication as an integer
Topic	getTopic() Returns the Topic of the Publication
int	getYear() Returns the year of publication
void	initialize(int id, int year, Topic topic, AuthorGroup authors) Initializes the Publications with the specified parameters
void	initialize(int id, int year, Topic topic, AuthorGroup authors, PublicationGroup citations) Initializes the Publications with the specified parameters

Method Detail

initialize

public void initialize(int id,
                       int year,
                       Topic topic,
                       AuthorGroup authors)
                throws TarlException

Initializes the Publications with the specified parameters

Parameters:

id - Specifies the unique publication identification

year - Specifies the year of publication

topic - Specifies the topic of the publication

authors - Specifies the authors who have collaborated for the publication

Throws:

TarlException - if the new publication cannot be initialized

initialize

public void initialize(int id,
                       int year,
                       Topic topic,
                       AuthorGroup authors,
                       PublicationGroup citations)
                throws TarlException

Initializes the Publications with the specified parameters

Parameters:

id - Specifies the unique publication identification

year - Specifies the year of publication

topic - Specifies the topic of the publication

authors - Specifies the authors who have collaborated for the publication

citations - Specifies the citations for the publication

Throws:

TarlException - if the new publication cannot be initialized

getId

public int getId()

Returns the unique identifier assigned by the PublicationDatabaseInterface of the Publication as an integer

Returns:

the unique identifier of the publication

getYear

public int getYear()

Returns the year of publication

Returns:

the year of publication

getTopic

public Topic getTopic()

Returns the Topic of the Publication

Returns:

the topic of the publication

getAuthors

public AuthorGroup getAuthors()

Returns the Authors who have collaborated for the Publication

Returns:

the authors who have collaborated for the publication

getCitations

public PublicationGroup getCitations()

Returns the citations of the Publication

Returns:

the citations of the publication

equals

public boolean equals(Publication publicationInterface)

Tests whether the current Publication is the same as the specified one. This test should be based on the identification tag that the PublicationDatabase has assigned to both the Publications.

Parameters:

publicationInterface - Specifies the publication to be equated against

Returns:

true, if the current publication is equal to the specified one