edu.iu.iv.modeling.tarl.input.impl
Class DefaultPublicationParameters

java.lang.Object
  |
  +--edu.iu.iv.modeling.tarl.input.impl.DefaultPublicationParameters

All Implemented Interfaces:

PublicationParameters

public class DefaultPublicationParameters

extends java.lang.Object

implements PublicationParameters

This class defines a default implementation of the PublicationParametersInterface interface. It defines model parameters which are related to Publications and methods to access them. This class is directly used by the DefaultPublicationManager class.

Author:

Jeegar T Maru

See Also:

DefaultPublicationManager, DefaultExecuterParameters

Constructor Summary

DefaultPublicationParameters()
Creates a new default instance for PublicationParameters.

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPublicationParameters

public DefaultPublicationParameters()

Creates a new default instance for PublicationParameters. The default values are the values mentioned in the PNAS paper.

Method Detail

initializeDefault

public void initializeDefault()

Initializes the PublicationParameters with default values

Specified by:

initializeDefault in interface PublicationParameters

getAgingEnabled

public boolean getAgingEnabled()

Returns whether aging has been enabled for the model or not

Specified by:

getAgingEnabled in interface PublicationParameters

Returns:

true, if aging has been enabled

getNumPublicationsRead

public int getNumPublicationsRead()

Returns the number of publications to be read

Specified by:

getNumPublicationsRead in interface PublicationParameters

Returns:

the number of publications to be read

getNumPublicationsCited

public int getNumPublicationsCited()

Returns the number of publications to be cited

Specified by:

getNumPublicationsCited in interface PublicationParameters

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

Specified by:

getNumPublicationsWritten in interface PublicationParameters

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

Specified by:

getNumLevelsReferences in interface PublicationParameters

Returns:

the number of levels of references considered for reading publications

getYearInformation

public YearInformation getYearInformation()

Returns the YearInformation for the model

Specified by:

getYearInformation in interface PublicationParameters

Returns:

the year information for the model

setAgingEnabled

public void setAgingEnabled(boolean agingEnabled)
                     throws TarlException

Stores whether aging has been enabled for the model or not

Specified by:

setAgingEnabled in interface PublicationParameters

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

Specified by:

setNumPublicationsRead in interface PublicationParameters

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

Specified by:

setNumPublicationsCited in interface PublicationParameters

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

Specified by:

setNumPublicationsWritten in interface PublicationParameters

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

Specified by:

setNumLevelsReferences in interface PublicationParameters

Parameters:

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

Throws:

TarlException - if the field is set with an invalid value

setYearInformation

public void setYearInformation(YearInformation yearInformation)

Stores the YearInformation for the model

Specified by:

setYearInformation in interface PublicationParameters

Parameters:

yearInformation - Specifies the year information for the model