Neil McErlean bd50b3df70 RatingService Phase 1.
The RatingService will allow users to apply ratings to content nodes in the repository.
  There will be a number of built-in Rating Schemes and support to add more by the usual extension mechanism.
  Out of the box, we envision a 'likes' scheme (user X likes this document) and a 'star' rating
    (user X gave this document 3 out of 5 stars).

  Content model for ratings.
  Spring config includes two out-of-the-box rating schemes
  Various basic infrastructure classes for Ratings, RatingSchemes and the service itself.
  Basic CRUD for ratings in a Java foundation layer.
  Associated JUnit tests.

The next contribution will add support for per-node average and total ratings and associated tests.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21000 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-07-08 13:59:58 +00:00

95 lines
2.4 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.rating;
import org.alfresco.service.cmr.rating.RatingScheme;
import org.springframework.beans.factory.BeanNameAware;
/**
* TODO
* @author Neil McErlean
* @since 3.4
*/
public class RatingSchemeImpl implements RatingScheme, BeanNameAware
{
private final RatingSchemeRegistry ratingSchemeRegistry;
private String name;
private int minRating, maxRating;
public RatingSchemeImpl(RatingSchemeRegistry registry)
{
this.ratingSchemeRegistry = registry;
}
public void init()
{
ratingSchemeRegistry.register(this.name, this);
}
/*
* (non-Javadoc)
* @see org.springframework.beans.factory.BeanNameAware#setBeanName(java.lang.String)
*/
public void setBeanName(String name)
{
this.name = name;
}
public void setMinRating(int minRating)
{
this.minRating = minRating;
}
public void setMaxRating(int maxRating)
{
this.maxRating = maxRating;
}
//TODO afterPropertiesSet assert Max > Min
public int getMaxRating()
{
return this.maxRating;
}
public int getMinRating()
{
return this.minRating;
}
public String getName()
{
return this.name;
}
@Override
public String toString()
{
StringBuilder msg = new StringBuilder();
msg.append(this.getClass().getSimpleName())
.append(" ").append(this.name)
.append(" [").append(this.minRating)
.append("..").append(this.maxRating)
.append("]");
return msg.toString();
}
}