mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
7dd2291753
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
107413: Merged DEV to 5.0.N (5.0.3)
106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Cleaning of Javadoc,
107565: MNT-13545 Fix compilation after merge of Javadoc
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
99 lines
3.3 KiB
Java
99 lines
3.3 KiB
Java
/*
|
|
* Copyright (C) 2005-2011 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 java.io.Serializable;
|
|
|
|
import org.alfresco.service.cmr.rating.RatingService;
|
|
import org.alfresco.service.cmr.rating.RatingServiceException;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.NodeService;
|
|
import org.alfresco.service.namespace.NamespaceService;
|
|
import org.springframework.beans.factory.InitializingBean;
|
|
|
|
/**
|
|
* This class provides the basic implementation of a rating property rollup.
|
|
* By providing an implementation of this class (or reusing an existing one),
|
|
* injecting the object into the {@link org.alfresco.service.cmr.rating.RatingScheme} and following the content
|
|
* model naming conventions, it
|
|
* should be possible to have new rating property rollups automatically calculated
|
|
* and persisted into the Alfresco content model, thereby enabling indexing, searching
|
|
* and sorting of rating-related properties.
|
|
*
|
|
* @author Neil McErlean
|
|
* @since 3.5
|
|
*/
|
|
public abstract class AbstractRatingRollupAlgorithm implements InitializingBean
|
|
{
|
|
protected String ratingSchemeName;
|
|
protected NamespaceService namespaceService;
|
|
protected NodeService nodeService;
|
|
protected RatingServiceImpl ratingServiceImpl;
|
|
|
|
protected final String rollupName;
|
|
|
|
public AbstractRatingRollupAlgorithm(String rollupName)
|
|
{
|
|
this.rollupName = rollupName;
|
|
}
|
|
|
|
public void setRatingSchemeName(String ratingScheme)
|
|
{
|
|
this.ratingSchemeName = ratingScheme;
|
|
}
|
|
|
|
public void setNamespaceService(NamespaceService namespaceService)
|
|
{
|
|
this.namespaceService = namespaceService;
|
|
}
|
|
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
public void setRatingService(RatingService ratingService)
|
|
{
|
|
this.ratingServiceImpl = (RatingServiceImpl)ratingService;
|
|
}
|
|
|
|
@Override
|
|
public void afterPropertiesSet() throws Exception
|
|
{
|
|
if (ratingSchemeName == null)
|
|
{
|
|
throw new RatingServiceException("Illegal null ratingSchemeName in " + this.getClass().getSimpleName());
|
|
}
|
|
}
|
|
|
|
public abstract Serializable recalculate(NodeRef ratedNode);
|
|
|
|
/**
|
|
* This method returns the rollup name, for example "Total" or "Count".
|
|
* This rollup name is used as part of the convention-based naming of content model
|
|
* property names.
|
|
* @return String
|
|
*/
|
|
public String getRollupName()
|
|
{
|
|
return this.rollupName;
|
|
}
|
|
}
|