edu.iu.iv.modeling.tarl.input
Interface PublicationParameters

All Known Implementing Classes:

DefaultPublicationParameters

public interface PublicationParameters

This interface defines the Parameters for the PublicationManager module of Tarl. These parameters are used only by the PublicationManager module.

Author:

Jeegar T Maru

See Also:

ExecuterParameters

Method Summary

boolean	getAgingEnabled() Returns whether aging has been enabled for the model or not
int	getNumLevelsReferences() Returns the number of levels of references considered for reading publications
int	getNumPublicationsCited() Returns the number of Publications to be cited
int	getNumPublicationsRead() Returns the number of Publications to be read
int	getNumPublicationsWritten() Returns the number of Publications to be written by each Author each year
YearInformation	getYearInformation() Returns the YearInformation for the model
void	initializeDefault() Initializes the PublicationParameters with default values
void	setAgingEnabled(boolean agingEnabled) Stores whether aging has been enabled for the model or not
void	setNumLevelsReferences(int numLevelsReferences) Stores the number of levels of references considered for reading Publications
void	setNumPublicationsCited(int numPublicationsCited) Stores the number of Publications to be cited
void	setNumPublicationsRead(int numPublicationsRead) Stores the number of Publications to be read
void	setNumPublicationsWritten(int numPublicationsWritten) Stores the number of Publications to be written by each Author each year
void	setYearInformation(YearInformation yearInformation) Stores the YearInformation for the model

Method Detail

initializeDefault

public void initializeDefault()

Initializes the PublicationParameters with default values

getAgingEnabled

public boolean getAgingEnabled()

Returns whether aging has been enabled for the model or not

Returns:

true, if aging has been enabled

getNumPublicationsRead

public int getNumPublicationsRead()

Returns the number of Publications to be read

Returns:

the number of publications to be read

getNumPublicationsCited

public int getNumPublicationsCited()

Returns the number of Publications to be cited

Returns:

the number of publications to be cited

getNumPublicationsWritten

public int getNumPublicationsWritten()

Returns the number of Publications to be written by each Author each year

Returns:

the number of publications to be written by each author each year

getNumLevelsReferences

public int getNumLevelsReferences()

Returns the number of levels of references considered for reading publications

Returns:

the number of levels of references considered for reading publications

setAgingEnabled

public void setAgingEnabled(boolean agingEnabled)
                     throws TarlException

Stores whether aging has been enabled for the model or not

Parameters:

agingEnabled - Specifies whether aging has been enabled

Throws:

TarlException - if the field is set with an invalid value

setNumPublicationsRead

public void setNumPublicationsRead(int numPublicationsRead)
                            throws TarlException

Stores the number of Publications to be read

Parameters:

numPublicationsRead - the number of publications to be read

Throws:

TarlException - if the field is set with an invalid value

setNumPublicationsCited

public void setNumPublicationsCited(int numPublicationsCited)
                             throws TarlException

Stores the number of Publications to be cited

Parameters:

numPublicationsCited - the number of publications to be cited

Throws:

TarlException - if the field is set with an invalid value

setNumPublicationsWritten

public void setNumPublicationsWritten(int numPublicationsWritten)
                               throws TarlException

Stores the number of Publications to be written by each Author each year

Parameters:

numPublicationsWritten - the number of publications to be written by each author each year

Throws:

TarlException - if the field is set with an invalid value

setNumLevelsReferences

public void setNumLevelsReferences(int numLevelsReferences)
                            throws TarlException

Stores the number of levels of references considered for reading Publications

Parameters:

numLevelsReferences - the number of levels of references considered for reading publications

Throws:

TarlException - if the field is set with an invalid value

getYearInformation

public YearInformation getYearInformation()

Returns the YearInformation for the model

Returns:

the year information for the model

setYearInformation

public void setYearInformation(YearInformation yearInformation)

Stores the YearInformation for the model

Parameters:

yearInformation - Specifies the year information for the model