edu.iu.iv.modeling.tarl.publication
Class AbstractPublicationUtility

java.lang.Object
  |
  +--edu.iu.iv.modeling.tarl.publication.AbstractPublicationUtility
Direct Known Subclasses:
DefaultPublicationUtility

public abstract class AbstractPublicationUtility
extends java.lang.Object

This abstract class defines the functions in order to filter Publications based on their attributes. Some of the functions that it fulfils are filtering based on the year of publication, Topic, Authors and citations.

Author:
Jeegar T Maru
See Also:
Publication, PublicationGroup

Constructor Summary
AbstractPublicationUtility()
           
 
Method Summary
static PublicationGroup filterOnAuthorEquality(PublicationGroup publicationGroup, Author author)
          Filters based on the Author of Publication on the conditions of equality with the specified Author.
static PublicationGroup filterOnCitationEquality(PublicationGroup publicationGroup, Publication citation)
          Filters based on the Citation of Publication on the conditions of equality with the specified Topic.
static PublicationGroup filterOnTopicEquality(PublicationGroup publicationGroup, Topic topic)
          Filters based on the Topic of Publication on the conditions of equality with the specified Topic.
static PublicationGroup filterOnYearEquality(PublicationGroup publicationGroup, int year)
          Filters out all the Publications which do not have the same year of publications as specified.
static PublicationGroup filterOnYearLessThan(PublicationGroup publicationGroup, int year)
          Filters out all the Publications which have a year greater than or equal to the specified year
static PublicationGroup getAllCitedPublications(PublicationGroup publicationGroup, int numLevels)
          Returns the Group of Publications cited by the specified Group uptil the specified level of references
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractPublicationUtility

public AbstractPublicationUtility()
Method Detail

filterOnYearEquality

public static PublicationGroup filterOnYearEquality(PublicationGroup publicationGroup,
                                                    int year)
Filters out all the Publications which do not have the same year of publications as specified. It returns a group of all the Publications which have the same year of publication as the specified one.

Parameters:
publicationGroup - Specifies the group of publications on which to apply the filter
year - Specifies the year of publication to be equated against
Returns:
the group of publications which are published in the specified year

filterOnYearLessThan

public static PublicationGroup filterOnYearLessThan(PublicationGroup publicationGroup,
                                                    int year)
Filters out all the Publications which have a year greater than or equal to the specified year

Parameters:
publicationGroup - Specifies the group of publications on which to apply the filter
year - Specifies the year of publication
Returns:
the group of publications which are published before the specified year

filterOnTopicEquality

public static PublicationGroup filterOnTopicEquality(PublicationGroup publicationGroup,
                                                     Topic topic)
Filters based on the Topic of Publication on the conditions of equality with the specified Topic. It returns a group of all the Publications which have the specified Topic.

Parameters:
publicationGroup - Specifies the group of publications on which to apply the filter
topic - Specifies the topic of publication to be equated against
Returns:
the group of publications which belong to the specified topic

filterOnAuthorEquality

public static PublicationGroup filterOnAuthorEquality(PublicationGroup publicationGroup,
                                                      Author author)
Filters based on the Author of Publication on the conditions of equality with the specified Author. It returns a group of all the Publications which have the specified Author.

Parameters:
publicationGroup - Specifies the group of publications on which to apply the filter
author - Specifies the author of publication to be equated against
Returns:
the group of publications on which the specified author has collaborated on

filterOnCitationEquality

public static PublicationGroup filterOnCitationEquality(PublicationGroup publicationGroup,
                                                        Publication citation)
Filters based on the Citation of Publication on the conditions of equality with the specified Topic. It returns a group of all the Publications which cite the specified Publication.

Parameters:
publicationGroup - Specifies the group of publications on which to apply the filter
citation - Specifies the citation to be equated against
Returns:
the group of publications which cited the specified publication

getAllCitedPublications

public static PublicationGroup getAllCitedPublications(PublicationGroup publicationGroup,
                                                       int numLevels)
Returns the Group of Publications cited by the specified Group uptil the specified level of references

Parameters:
publicationGroup - Specifies the group of publications whose citations are to be collected
numLevels - Specifies the number of levels of references to consider
Returns:
the group of citations of the specified group of publications