org.alfresco.repo.rating

Class RatingSchemeImpl

java.lang.Object

org.alfresco.repo.rating.RatingSchemeImpl

All Implemented Interfaces:

Comparable<RatingScheme>, RatingScheme, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class RatingSchemeImpl
extends Object
implements RatingScheme, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description
RatingSchemeImpl(RatingSchemeRegistry registry)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
int	compareTo(RatingScheme otherScheme) This method can be used to sort RatingSchemes by name.
float	getMaxRating() This method returns the maximum rating defined for this scheme.
float	getMinRating() This method returns the minimum rating defined for this scheme.
String	getModelPrefix() This method returns the namespace (prefix e.g.
String	getName() This method returns the name which uniquely identifies the rating scheme.
List<AbstractRatingRollupAlgorithm>	getPropertyRollups() This method returns a List of property rollup algorithms which are used in order to calculate rating totals, counts etc for a rated node.
void	init()
boolean	isSelfRatingAllowed() This method returns true if the cm:creator of the node is allowed to apply a rating to it, else false.
void	setBeanName(String name)
void	setMaxRating(float maxRating)
void	setMinRating(float minRating)
void	setModelPrefix(String prefix)
void	setPropertyRollups(List<AbstractRatingRollupAlgorithm> rollupAlgorithms)
void	setSelfRatingAllowed(boolean selfRatingAllowed)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingSchemeImpl

public RatingSchemeImpl(RatingSchemeRegistry registry)

Method Detail

setPropertyRollups

public void setPropertyRollups(List<AbstractRatingRollupAlgorithm> rollupAlgorithms)

setModelPrefix

public void setModelPrefix(String prefix)

init

public void init()

getPropertyRollups

public List<AbstractRatingRollupAlgorithm> getPropertyRollups()

Description copied from interface: RatingScheme

This method returns a List of property rollup algorithms which are used in order to calculate rating totals, counts etc for a rated node.

Specified by:

getPropertyRollups in interface RatingScheme

Returns:

an unmodifiable list of property rollup algorithms.

getModelPrefix

public String getModelPrefix()

Description copied from interface: RatingScheme

This method returns the namespace (prefix e.g. "cm") of the Alfresco content model containing the definitions of the rollup aspect and properties.

Specified by:

getModelPrefix in interface RatingScheme

See Also:

RatingNamingConventionsUtil

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

setMinRating

public void setMinRating(float minRating)

setMaxRating

public void setMaxRating(float maxRating)

setSelfRatingAllowed

public void setSelfRatingAllowed(boolean selfRatingAllowed)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getMaxRating

public float getMaxRating()

Description copied from interface: RatingScheme

This method returns the maximum rating defined for this scheme.

Specified by:

getMaxRating in interface RatingScheme

Returns:

the maximum rating.

getMinRating

public float getMinRating()

Description copied from interface: RatingScheme

This method returns the minimum rating defined for this scheme.

Specified by:

getMinRating in interface RatingScheme

Returns:

the minimum rating.

isSelfRatingAllowed

public boolean isSelfRatingAllowed()

Description copied from interface: RatingScheme

This method returns true if the cm:creator of the node is allowed to apply a rating to it, else false.

Specified by:

isSelfRatingAllowed in interface RatingScheme

Returns:

whether or not the cm:creator of the node can apply a rating in this scheme.

getName

public String getName()

Description copied from interface: RatingScheme

This method returns the name which uniquely identifies the rating scheme.

Specified by:

getName in interface RatingScheme

Returns:

the name.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(RatingScheme otherScheme)

This method can be used to sort RatingSchemes by name.

Specified by:

compareTo in interface Comparable<RatingScheme>

Since:

4.1.5