eu.dnetlib.clients.functionality.rating.ws

Class RatingWebServiceImpl

java.lang.Object

eu.dnetlib.clients.ws.BaseDriverWebService<eu.dnetlib.api.functionality.RatingService>

eu.dnetlib.clients.functionality.rating.ws.RatingWebServiceImpl

All Implemented Interfaces:

eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.RatingService>, RatingWebService, DriverWebService<eu.dnetlib.api.functionality.RatingService>, eu.dnetlib.common.rmi.BaseService

public class RatingWebServiceImpl
extends BaseDriverWebService<eu.dnetlib.api.functionality.RatingService>
implements RatingWebService

This class implements rating web service using a rating service.

Author:

thanos@di.uoa.gr

Field Summary

Fields inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

service

Constructor Summary

Constructors

Constructor and Description
RatingWebServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<eu.dnetlib.domain.functionality.Rating>	getTopDocuments(int limit) Get the top documents.
List<eu.dnetlib.domain.functionality.Rating>	getTopRatings(int limit) Get the top ratings.
void	rate(String userId, String documentId, float score) Rate a document by a specifed user.
List<eu.dnetlib.domain.functionality.Rating>	searchRatingsByDocument(String documentId) Search for existing ratings by document.
List<eu.dnetlib.domain.functionality.Rating>	searchRatingsByUser(String userId) Search for existing ratings by user.

Methods inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

identify, notify, setService, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Constructor Detail

RatingWebServiceImpl

public RatingWebServiceImpl()

Method Detail

getTopDocuments

public List<eu.dnetlib.domain.functionality.Rating> getTopDocuments(int limit)
                                                             throws RatingWebServiceException

Description copied from interface: RatingWebService

Get the top documents.

Specified by:

getTopDocuments in interface RatingWebService

Parameters:

limit - the maximum number of ratings to retrieve

Returns:

a list containing the top document average ratings ordered by score

Throws:

RatingWebServiceException - if any errors occur

getTopRatings

public List<eu.dnetlib.domain.functionality.Rating> getTopRatings(int limit)
                                                           throws RatingWebServiceException

Description copied from interface: RatingWebService

Get the top ratings.

Specified by:

getTopRatings in interface RatingWebService

Parameters:

limit - the maximum number of ratings to retrieve

Returns:

a list containing the top ratings ordered by score

Throws:

RatingWebServiceException - if any errors occur

rate

public void rate(String userId,
                 String documentId,
                 float score)
          throws RatingWebServiceException

Description copied from interface: RatingWebService

Rate a document by a specifed user.

Specified by:

rate in interface RatingWebService

Parameters:

userId - the id of the user

documentId - the id of the document

score - the rating score

Throws:

RatingWebServiceException - if any errors occur

searchRatingsByDocument

public List<eu.dnetlib.domain.functionality.Rating> searchRatingsByDocument(String documentId)
                                                                     throws RatingWebServiceException

Description copied from interface: RatingWebService

Search for existing ratings by document.

Specified by:

searchRatingsByDocument in interface RatingWebService

Parameters:

documentId - the id of the document

Returns:

a list containing all the ratings of the soecified document ordered by score

Throws:

RatingWebServiceException - if any errors occur

searchRatingsByUser

public List<eu.dnetlib.domain.functionality.Rating> searchRatingsByUser(String userId)
                                                                 throws RatingWebServiceException

Description copied from interface: RatingWebService

Search for existing ratings by user.

Specified by:

searchRatingsByUser in interface RatingWebService

Parameters:

userId - the id of the user

Returns:

a list containing all the ratings of the specified user ordered by score

Throws:

RatingWebServiceException - if any errors occur