Salome HOME
Satisfy some PMD rules.
[tools/siman.git] / Workspace / Siman-Common / src / org / splat / service / StudyServiceImpl.java
index 1826adb0589108f978ac6bdd8c4238f60ee34d09..d75d3ccfa29cd440919d9bd6ac10de208b6a8753 100644 (file)
@@ -9,18 +9,38 @@
 
 package org.splat.service;
 
+import java.awt.Graphics2D;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
 import java.io.IOException;
 import java.text.DecimalFormat;
 import java.text.SimpleDateFormat;
+import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Collections;
 import java.util.Date;
+import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Scanner;
 import java.util.Set;
 
+import org.apache.lucene.index.IndexWriter;
+import org.apache.lucene.store.FSDirectory;
+import org.hibernate.Criteria;
+import org.hibernate.Hibernate;
+import org.hibernate.criterion.DetachedCriteria;
 import org.hibernate.criterion.Restrictions;
+import org.hibernate.proxy.HibernateProxy;
+import org.jfree.chart.ChartFactory;
+import org.jfree.chart.JFreeChart;
+import org.jfree.chart.plot.PlotOrientation;
+import org.jfree.data.xy.XYSeries;
+import org.jfree.data.xy.XYSeriesCollection;
+import org.splat.common.properties.MessageKeyEnum;
 import org.splat.dal.bo.kernel.Relation;
 import org.splat.dal.bo.kernel.User;
 import org.splat.dal.bo.som.ActorRelation;
@@ -28,37 +48,55 @@ import org.splat.dal.bo.som.ContributorRelation;
 import org.splat.dal.bo.som.DescriptionAttribute;
 import org.splat.dal.bo.som.DocumentType;
 import org.splat.dal.bo.som.IDBuilder;
-import org.splat.dal.bo.som.KnowledgeElement;
 import org.splat.dal.bo.som.ProgressState;
+import org.splat.dal.bo.som.ProjectElement;
 import org.splat.dal.bo.som.Publication;
+import org.splat.dal.bo.som.ReaderRelation;
 import org.splat.dal.bo.som.Scenario;
 import org.splat.dal.bo.som.SimulationContext;
 import org.splat.dal.bo.som.Study;
-import org.splat.dal.bo.som.Study.Properties;
 import org.splat.dal.bo.som.ValidationCycle;
-import org.splat.dal.bo.som.ValidationCycle.Actor;
 import org.splat.dal.bo.som.ValidationCycleRelation;
 import org.splat.dal.bo.som.ValidationStep;
 import org.splat.dal.bo.som.Visibility;
+import org.splat.dal.bo.som.Study.Properties;
+import org.splat.dal.bo.som.ValidationCycle.Actor;
 import org.splat.dal.dao.som.DescriptionAttributeDAO;
 import org.splat.dal.dao.som.DocumentDAO;
 import org.splat.dal.dao.som.IDBuilderDAO;
 import org.splat.dal.dao.som.PublicationDAO;
 import org.splat.dal.dao.som.ScenarioDAO;
 import org.splat.dal.dao.som.StudyDAO;
+import org.splat.dal.dao.som.UsedByRelationDAO;
 import org.splat.dal.dao.som.ValidationCycleDAO;
+import org.splat.exception.BusinessException;
+import org.splat.exception.IncompatibleDataException;
 import org.splat.exception.InvalidParameterException;
 import org.splat.kernel.InvalidPropertyException;
+import org.splat.kernel.MismatchException;
 import org.splat.kernel.MissedPropertyException;
 import org.splat.kernel.MultiplyDefinedException;
 import org.splat.log.AppLogger;
+import org.splat.service.dto.DocToCompareDTO;
+import org.splat.service.dto.DocumentDTO;
+import org.splat.service.dto.StudyFacadeDTO;
+import org.splat.service.dto.UserDTO;
 import org.splat.service.technical.IndexService;
 import org.splat.service.technical.ProjectSettingsService;
 import org.splat.service.technical.ProjectSettingsServiceImpl;
 import org.splat.service.technical.RepositoryService;
+import org.splat.service.technical.ProjectSettingsService.Step;
 import org.splat.som.Revision;
+import org.splat.util.BeanHelper;
 import org.springframework.transaction.annotation.Transactional;
 
+import com.lowagie.text.Document;
+import com.lowagie.text.DocumentException;
+import com.lowagie.text.Rectangle;
+import com.lowagie.text.pdf.DefaultFontMapper;
+import com.lowagie.text.pdf.PdfContentByte;
+import com.lowagie.text.pdf.PdfTemplate;
+import com.lowagie.text.pdf.PdfWriter;
 
 /**
  * This class defines all methods for creation, modification the study.
@@ -73,6 +111,10 @@ public class StudyServiceImpl implements StudyService {
         */
        public final static AppLogger LOG = AppLogger
                        .getLogger(StudyServiceImpl.class);
+       /**
+        * "studyId" parameter name.
+        */
+       public final static String PARAM_STUDY_ID = "studyId";
 
        /**
         * Injected index service.
@@ -99,6 +141,11 @@ public class StudyServiceImpl implements StudyService {
         */
        private StudyDAO _studyDAO;
 
+       /**
+        * Injected usedBy relations DAO.
+        */
+       private UsedByRelationDAO _usedByRelationDAO;
+
        /**
         * Injected scenario DAO.
         */
@@ -149,14 +196,71 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#selectStudy(long)
         */
-       @Override
        @Transactional
        public Study selectStudy(final long index) {
                Study result = getStudyDAO().get(index);
-               loadWorkflow(result);
+               if (result != null) {
+                       loadWorkflow(result);
+               }
                return result;
        }
 
+       /**
+        * {@inheritDoc}
+        * 
+        * @see org.splat.service.StudyService#removeStudy(long)
+        */
+       @Transactional
+       public void removeStudy(final Long index) {
+               Study study = getStudyDAO().get(index);
+               Set<org.splat.dal.bo.som.Document> docums = new HashSet<org.splat.dal.bo.som.Document>();
+               if (study != null) {
+                       // Select all documents published in the study and study's scenarios.
+                       DetachedCriteria query = DetachedCriteria.forClass(
+                                       Publication.class, "pub");
+                       query
+                                       .createCriteria("pub.owner", "projelem",
+                                                       Criteria.INNER_JOIN)
+                                       .createAlias("projelem.owner", "study", Criteria.LEFT_JOIN)
+                                       .add(
+                                                       Restrictions
+                                                                       .or(Restrictions.eq("projelem.rid", index),
+                                                                                       Restrictions.eq("study.rid", index)))
+                                       .setResultTransformer(Criteria.DISTINCT_ROOT_ENTITY);
+
+                       if (LOG.isDebugEnabled()) {
+                               LOG.debug("Find study documents: " + query.toString());
+                       }
+                       for (Publication pub : getPublicationDAO().getFilteredList(query)) {
+                               docums.add(pub.value());
+                               // Find also all previous versions of the document
+                               for (org.splat.dal.bo.som.Document prev = pub.value()
+                                               .getPreviousVersion(); prev != null; prev = prev
+                                               .getPreviousVersion()) {
+                                       docums.add(prev);
+                               }
+                       }
+
+                       // Delete the study with its relations, scenarios and publications
+                       getStudyDAO().delete(study);
+
+                       // Remove all relations of study documents
+                       for (org.splat.dal.bo.som.Document doc : docums) {
+                               LOG.debug("Found doc: " + doc.getTitle() + " ["
+                                               + doc.getReference() + "]" + " [" + doc.getRid() + "]");
+                               doc.getAllRelations().clear();
+                       }
+                       getDocumentDAO().flush();
+
+                       // Remove all documents of the study
+                       for (org.splat.dal.bo.som.Document doc : docums) {
+                               LOG.debug("Remove doc: " + doc.getTitle() + " ["
+                                               + doc.getReference() + "]" + " [" + doc.getRid() + "]");
+                               getDocumentDAO().delete(doc);
+                       }
+               }
+       }
+
        /**
         * Get study by its reference.
         * 
@@ -177,7 +281,6 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#createStudy(org.splat.dal.bo.som.Study.Properties)
         */
-       @Override
        @Transactional
        public Study createStudy(final Study.Properties sprop)
                        throws MissedPropertyException, InvalidPropertyException,
@@ -187,14 +290,14 @@ public class StudyServiceImpl implements StudyService {
 
                buildReference(study);
                getStudyDAO().create(study);
-               try {
-                       IndexService lucin = getIndex();
-                       lucin.add(study);
-               } catch (IOException error) {
-                       LOG.error("Unable to index the study '" + study.getIndex()
-                                       + "', reason:", error);
-                       // Continue and try to index later
-               }
+               // try {
+               // IndexService lucin = getIndex();
+               // lucin.add(study);
+               // } catch (IOException error) {
+               // LOG.error("Unable to index the study '" + study.getIndex()
+               // + "', reason:", error);
+               // // Continue and try to index later
+               // }
                return study;
        }
 
@@ -203,7 +306,6 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext.Properties)
         */
-       @Override
        @Transactional
        public SimulationContext addProjectContext(final Study aStudy,
                        final SimulationContext.Properties cprop)
@@ -220,7 +322,6 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
         */
-       @Override
        @Transactional
        public SimulationContext addProjectContext(final Study aStudy,
                        final SimulationContext context) {
@@ -235,22 +336,33 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#addContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User)
         */
-       @Override
+       @Transactional
        public boolean addContributor(final Study aStudy, final User user) {
-               List<User> contributor = getModifiableContributors(aStudy); // Initializes contributor
-               for (Iterator<User> i = contributor.iterator(); i.hasNext();) {
-                       User present = i.next();
-                       if (present.equals(user)) {
-                               return false;
+               List<User> contributors = getModifiableContributors(aStudy); // Initializes contributor
+               
+               if(contributors.contains(user)) {
+                       return false;
+               }
+               
+               //Remove user from readers
+               try {
+                       List<UserDTO> readers = getReaders(aStudy.getIndex());
+                       for(UserDTO reader : readers) {
+                               if(reader.getIndex() == user.getIndex()) {
+                                       //user must be the actual user in the relationship object in the aStudy object for this to work
+                                       aStudy.removeRelation(ReaderRelation.class, user);
+                               }
                        }
+               } catch(InvalidParameterException e) {
+                       LOG.error(e.getMessage(), e);   
                }
+               
                boolean absent = getModifiableActors(aStudy).add(user); // User may already be a reviewer or an approver
 
                aStudy.addRelation(new ContributorRelation(aStudy, user));
                if (absent) {
                        update(aStudy); // Else, useless to re-index the study
                }
-               contributor.add(user);
                return true;
        }
 
@@ -265,7 +377,7 @@ public class StudyServiceImpl implements StudyService {
         * @see #isPublic()
         * @see Publication#approve(Date)
         */
-       @Override
+       @Transactional
        public boolean moveToReference(final Study aStudy) {
                if (aStudy.getProgressState() != ProgressState.APPROVED) {
                        return false;
@@ -286,7 +398,7 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#update(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.Study.Properties)
         */
-       @Override
+       @Transactional
        public boolean update(final Study aStudy, final Properties sprop)
                        throws InvalidPropertyException {
                if (sprop.getTitle() != null) {
@@ -309,39 +421,24 @@ public class StudyServiceImpl implements StudyService {
         *            the document
         * @return true if the document is published in the study
         */
-/*     private boolean publishes(final Study aStudy, final Document doc) {
-               if (!aStudy.publishes(doc)) {
-                       Scenario[] scene = aStudy.getScenarii();
-                       for (int i = 0; i < scene.length; i++) {
-                               if (scene[i].publishes(doc)) {
-                                       return true;
-                               }
-                       }
-               }
-               return false;
-       }
-*/
+       /*
+        * private boolean publishes(final Study aStudy, final Document doc) { if (!aStudy.publishes(doc)) { Scenario[] scene =
+        * aStudy.getScenarii(); for (int i = 0; i < scene.length; i++) { if (scene[i].publishes(doc)) { return true; } } } return false; }
+        */
        /**
         * {@inheritDoc}
         * 
         * @see org.splat.service.StudyService#removeContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User[])
         */
-       @Override
+       @Transactional
        public boolean removeContributor(final Study aStudy, final User... users) {
-               List<User> contributor = getModifiableContributors(aStudy); // Initializes contributor
+               List<User> contributors = getModifiableContributors(aStudy); // Initializes contributor
                Boolean done = false;
-               for (int i = 0; i < users.length; i++) {
-                       User user = users[i];
-                       for (Iterator<User> j = contributor.iterator(); j.hasNext();) {
-                               User present = j.next();
-                               if (!present.equals(user)) {
-                                       continue;
-                               }
-
+               for(User user : users) {
+                       if(contributors.contains(user)) {
                                aStudy.removeRelation(ContributorRelation.class, user);
-                               j.remove(); // Updates the contributor shortcut
+                               contributors.remove(user);
                                done = true;
-                               break;
                        }
                }
                if (done) {
@@ -355,7 +452,7 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#removeProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
         */
-       @Override
+       @Transactional
        public boolean removeProjectContext(final Study aStudy,
                        final SimulationContext context) {
                boolean done = getStepService().removeSimulationContext(
@@ -370,17 +467,17 @@ public class StudyServiceImpl implements StudyService {
         * @see org.splat.service.StudyService#setValidationCycle(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.DocumentType,
         *      org.splat.dal.bo.som.ValidationCycle.Properties)
         */
-       @Override
        @Transactional
-       public void setValidationCycle(final Study aStudyDTO, final DocumentType type,
-                       final ValidationCycle.Properties vprop) {
-               Map<String, ValidationCycle> validactor = aStudyDTO.getValidationCycles();
+       public void setValidationCycle(final Study aStudyDTO,
+                       final DocumentType type, final ValidationCycle.Properties vprop) {
+               Map<String, ValidationCycle> validactor = aStudyDTO
+                               .getValidationCycles();
                if (validactor == null) {
                        setShortCuts(aStudyDTO); // Initializes validactor and actor
                }
 
                Study aStudy = selectStudy(aStudyDTO.getIndex());
-               
+
                String cname = type.getName();
                ValidationCycle cycle = validactor.get(cname);
 
@@ -394,12 +491,12 @@ public class StudyServiceImpl implements StudyService {
 
                                ValidationCycleRelation link = cycle.getContext();
                                aStudy.addRelation(link);
+                               getValidationCycleDAO().flush();
                                aStudyDTO.getAllRelations().add(link); // RKV
 
                                validactor.put(cname, link.getTo()); // Replaces the cycle if exists as default,
-                       } catch (Exception error) {
-                               LOG.error("Unable to re-index Knowledge Elements, reason:",
-                                               error);
+                       } catch (BusinessException error) {
+                               LOG.error("Unable to create validation cycle, reason:", error);
                                return;
                        }
                }
@@ -415,7 +512,7 @@ public class StudyServiceImpl implements StudyService {
         *            a study to demote
         * @return true if the demotion succeeded.
         */
-       @Override
+       @Transactional
        public boolean demote(final Study aStudy) {
                if (aStudy.getProgressState() == ProgressState.inCHECK) {
                        aStudy.setProgressState(ProgressState.inDRAFT);
@@ -432,7 +529,6 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#generateLocalIndex(org.splat.dal.bo.som.Study)
         */
-       @Override
        @Transactional
        public int generateLocalIndex(final Study aStudy) {
                aStudy.setLastLocalIndex(aStudy.getLastLocalIndex() + 1);
@@ -447,7 +543,6 @@ public class StudyServiceImpl implements StudyService {
         *            a study to promote
         * @return true if the demotion succeeded.
         */
-       @Override
        @Transactional
        public boolean promote(final Study aStudy) {
                if (aStudy.getProgressState() == ProgressState.inWORK) {
@@ -476,7 +571,6 @@ public class StudyServiceImpl implements StudyService {
         * @return true if the move succeeded.
         * @see #isPublic()
         */
-       @Override
        @Transactional
        public boolean moveToPublic(final Study aStudy) {
                boolean isOk = false;
@@ -488,7 +582,7 @@ public class StudyServiceImpl implements StudyService {
                }
                return isOk;
        }
-       
+
        /**
         * Moves this study from the Public to the Private area of the repository.
         * 
@@ -496,7 +590,6 @@ public class StudyServiceImpl implements StudyService {
         *            a study to move
         * @return true if the move succeeded.
         */
-       @Override
        @Transactional
        public boolean moveToPrivate(final Study aStudy) {
                boolean isOk = false;
@@ -516,13 +609,12 @@ public class StudyServiceImpl implements StudyService {
         *            the study to update
         * @return true if the study is updated successfully
         */
-       @Transactional
        private boolean update(final Study aStudy) {
                boolean isOk = false;
                try {
                        getStudyDAO().merge(aStudy); // Update of relational base
                        setShortCuts(aStudy); // RKV: initialize transient actors set
-                       getIndex().update(aStudy); // Update of Lucene index
+                       //RKV: getIndex().update(aStudy); // Update of Lucene index
                        isOk = true;
                } catch (Exception e) {
                        LOG.error("STD-000001", e, aStudy.getIndex(), e.getMessage());
@@ -582,7 +674,7 @@ public class StudyServiceImpl implements StudyService {
                                                        break;
                                                }
                                        }
-                                       SimpleDateFormat tostring = new SimpleDateFormat("yyyy"); //RKV: NOPMD: TODO: Use locale here?
+                                       SimpleDateFormat tostring = new SimpleDateFormat("yyyy"); // RKV: NOPMD: TODO: Use locale here?
                                        String year = tostring.format(study.getDate());
                                        year = year.substring(4 - (i - n), 4); // 4-(i-n) must be equal to either 0 or 2
                                        for (int j = 0; j < year.length(); j++) {
@@ -670,25 +762,21 @@ public class StudyServiceImpl implements StudyService {
         * @return true if reindexing succeeded
         */
        private boolean updateKnowledgeElementsIndex(final Study aStudy) {
-               boolean isOk = false;
-               try {
-                       IndexService lucin = getIndex();
-
-                       for (Iterator<Scenario> i = aStudy.getScenariiList().iterator(); i
-                                       .hasNext();) {
-                               Scenario scene = i.next();
-                               for (Iterator<KnowledgeElement> j = scene
-                                               .getAllKnowledgeElements().iterator(); j.hasNext();) {
-                                       KnowledgeElement kelm = j.next();
-                                       lucin.update(kelm);
-                               }
-                       }
-                       isOk = true;
-               } catch (Exception error) {
-                       LOG.error("Unable to re-index Knowledge Elements, reason:",
-                                       error);
-               }
-               return isOk;
+//             boolean isOk = false;
+//              try {
+//                      IndexService lucin = getIndex();
+//                      for(Scenario scenario : aStudy.getScenariiList()) {
+//                              for (KnowledgeElement element : scenario.getAllKnowledgeElements()) {
+//                                      lucin.update(element);
+//                              }
+//                      }
+//                      isOk = true;
+//              } catch (Exception error) {
+//                      LOG.error("Unable to re-index Knowledge Elements, reason:",
+//                      error);
+//              }
+//              return isOk;
+               return true;
        }
 
        /**
@@ -700,6 +788,11 @@ public class StudyServiceImpl implements StudyService {
         */
        private IndexService getIndex() throws IOException {
                IndexService lucin = getIndexService();
+               if (IndexWriter.isLocked(FSDirectory.open(getRepositoryService()
+                               .getRepositoryIndexDirectory()))) {
+                       IndexWriter.unlock(FSDirectory.open(getRepositoryService()
+                                       .getRepositoryIndexDirectory()));
+               }
                if (!lucin.exists()) {
                        lucin.create(); // Happens when re-indexing all studies
                }
@@ -872,7 +965,6 @@ public class StudyServiceImpl implements StudyService {
         *            the study
         * @return the unmodifiable not null transient list of contributors of this study
         */
-       @Override
        public List<User> getContributors(final Study aStudy) {
                if (aStudy.getContributor() == null) {
                        setShortCuts(aStudy);
@@ -903,10 +995,10 @@ public class StudyServiceImpl implements StudyService {
         *            the document type being subject of validation
         * @return the validation cycle of the document, or null if not defined.
         */
-       @Override
        public ValidationCycle getValidationCycleOf(final Study aStudy,
                        final DocumentType type) {
-               if (aStudy.getValidationCycles() == null || aStudy.getValidationCycles().isEmpty()) {
+               if (aStudy.getValidationCycles() == null
+                               || aStudy.getValidationCycles().isEmpty()) {
                        setShortCuts(aStudy);
                }
                ValidationCycle result = aStudy.getValidationCycles().get(
@@ -932,7 +1024,6 @@ public class StudyServiceImpl implements StudyService {
         * @return true if the given user is actor of this study.
         * @see #getActors()
         */
-       @Override
        public boolean hasActor(final Study aStudy, final User user) {
                if (user == null) {
                        return false;
@@ -956,7 +1047,6 @@ public class StudyServiceImpl implements StudyService {
         * @return true if the given user is actor of this study.
         * @see #getContributors()
         */
-       @Override
        public boolean isStaffedBy(final Study aStudy, final User user) {
                if (user == null) {
                        return false;
@@ -984,7 +1074,6 @@ public class StudyServiceImpl implements StudyService {
         * @param aStudy
         *            the study
         */
-       @Override
        public void loadWorkflow(final Study aStudy) {
                setShortCuts(aStudy);
        }
@@ -1045,89 +1134,288 @@ public class StudyServiceImpl implements StudyService {
                        aStudy.getActor().add(((ActorRelation) link).getTo());
                }
        }
-       
+
        /**
         * 
         * {@inheritDoc}
+        * 
         * @see org.splat.service.StudyService#markStudyAsReference(org.splat.dal.bo.som.Study)
         */
-       @Override
        @Transactional
-       public void markStudyAsReference (final Study aStudy) {
-               
+       public void markStudyAsReference(final Study aStudy) {
+
                aStudy.setMarkreference(1);
                aStudy.setProgressState(ProgressState.TEMPLATE);
                getStudyDAO().merge(aStudy);
        }
-       
+
        /**
         * 
         * {@inheritDoc}
+        * 
         * @see org.splat.service.StudyService#removeStudyAsReference(org.splat.dal.bo.som.Study)
         */
-       @Override
        @Transactional
        public void removeStudyAsReference(final Study aStudy) {
-               
+
                aStudy.setMarkreference(0);
                aStudy.setProgressState(ProgressState.APPROVED);
                getStudyDAO().merge(aStudy);
        }
-       
-       
-       /** 
+
+       /**
         * {@inheritDoc}
+        * 
         * @see org.splat.service.StudyService#getDescription(java.lang.Long)
         */
        @Override
        @Transactional(readOnly = true)
-       public String getDescription(final Long studyId) throws InvalidParameterException {
-               if(studyId == null) {
-                       throw new InvalidParameterException("studyId", "null");
+       public String getDescription(final Long studyId)
+                       throws InvalidParameterException {
+               if (studyId == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, "null");
                }
                Study study = _studyDAO.get(studyId);
-               if(study == null) {
-                       throw new InvalidParameterException("studyId", studyId.toString());
+               if (study == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, studyId
+                                       .toString());
                }
                return study.getDescription();
        }
-       
-       
-       /** 
+
+       /**
         * {@inheritDoc}
+        * 
         * @see org.splat.service.StudyService#setDescription(java.lang.Long, java.lang.String)
         */
-       @Override
        @Transactional
-       public void setDescription(final Long studyId, final String descriptionText) 
+       public void setDescription(final Long studyId, final String descriptionText)
                        throws InvalidParameterException {
-               if(studyId == null) {
-                       throw new InvalidParameterException("studyId", "null");
+               if (studyId == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, "null");
                }
                Study study = _studyDAO.get(studyId);
-               if(study == null) {
-                       throw new InvalidParameterException("studyId", studyId.toString());
+               if (study == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, studyId
+                                       .toString());
                }
                study.setAttribute(new DescriptionAttribute(study, descriptionText));
        }
-       
-       /** 
+
+       /**
         * {@inheritDoc}
+        * 
         * @see org.splat.service.StudyService#removeStudyDescription(java.lang.Long)
         */
-       @Override
        @Transactional
-       public boolean removeDescription(final Long studyId) throws InvalidParameterException {
-               if(studyId == null) {
-                       throw new InvalidParameterException("studyId", String.valueOf(studyId));
+       public boolean removeDescription(final Long studyId)
+                       throws InvalidParameterException {
+               if (studyId == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String
+                                       .valueOf(studyId));
                }
                Study study = _studyDAO.get(studyId);
-               if(study == null) {
-                       throw new InvalidParameterException("studyId", String.valueOf(studyId));
+               if (study == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String
+                                       .valueOf(studyId));
                }
-               return study.removeAttribute(study.getAttribute(DescriptionAttribute.class));
+               return study.removeAttribute(study
+                               .getAttribute(DescriptionAttribute.class));
        }
 
+       /**
+        * 
+        * {@inheritDoc}
+        * 
+        * @see org.splat.service.StudyService#compare(java.util.List)
+        */
+       @Override
+       public String compare(final List<DocToCompareDTO> docsList,
+                       final String userName) throws IncompatibleDataException {
+
+               String axis1Name = "";
+               String axis2Name = "";
+               String chartTitle = "";
+               String resultPath = "";
+
+               XYSeriesCollection dataset = new XYSeriesCollection();
+
+               Iterator<DocToCompareDTO> docListIter = docsList.iterator();
+
+               for (; docListIter.hasNext();) {
+
+                       DocToCompareDTO docDTO = docListIter.next();
+                       String pathToFile = docDTO.getPathToFile();
+                       File compDocFile = new File(pathToFile);
+
+                       resultPath = pathToFile.substring(0, pathToFile.indexOf("vault"))
+                                       + "downloads" + File.separator + userName + File.separator
+                                       + "ComparisonResult.pdf";
+
+                       XYSeries series = new XYSeries("Study: " + docDTO.getStudyTitle()
+                                       + " Scenario: " + docDTO.getScenarioTitle() + " Document: "
+                                       + docDTO.getDocumentTitle());
+
+                       // read the file and get points information.
+                       try {
+                               Scanner input = new Scanner(compDocFile);
+
+                               // get the title of the chart.
+                               if (input.hasNext()) {
+                                       chartTitle = input.nextLine();
+                               }
+
+                               // get the name of the axis.
+                               if (input.hasNext()) {
+                                       String[] tokens = input.nextLine().split(",");
+
+                                       if (tokens.length < 2) {
+                                               throw new IncompatibleDataException(
+                                                               MessageKeyEnum.IDT_000001.toString());
+                                       }
+
+                                       if ("".equals(axis1Name)) {
+                                               axis1Name = tokens[0];
+                                       } else if (!axis1Name.equals(tokens[0])) {
+                                               LOG.debug("Axis must be the same for all documents");
+                                               throw new IncompatibleDataException(
+                                                               MessageKeyEnum.IDT_000001.toString());
+                                       }
+
+                                       if ("".equals(axis2Name)) {
+                                               axis2Name = tokens[1];
+                                       } else if (!axis2Name.equals(tokens[1])) {
+                                               LOG.debug("Axis must be the same for all documents");
+                                               throw new IncompatibleDataException(
+                                                               MessageKeyEnum.IDT_000001.toString());
+                                       }
+                               }
+
+                               // Get the XY points series.
+                               while (input.hasNext()) {
+
+                                       String currentString = input.nextLine();
+
+                                       if (!("".equals(currentString))) {
+                                               String[] tokens = currentString.split(" ");
+                                               series.add(Double.valueOf(tokens[0]), Double
+                                                               .valueOf(tokens[1]));
+                                       }
+
+                               } // while
+
+                               dataset.addSeries(series);
+
+                       } catch (FileNotFoundException e) {
+                               LOG.error("Sorry, the file is not found.", e);
+                       }
+               } // for
+
+               JFreeChart chart = ChartFactory.createXYLineChart(chartTitle, // Title
+                               axis1Name, // x-axis Label
+                               axis2Name, // y-axis Label
+                               dataset, // Dataset
+                               PlotOrientation.VERTICAL, // Plot Orientation
+                               true, // Show Legend
+                               true, // Use tooltips
+                               false // Configure chart to generate URLs?
+                               );
+
+               // export to PDF - file.
+               int x = 500;
+               int y = 300;
+               Rectangle pagesize = new Rectangle(x, y);
+               Document document = new Document(pagesize, 50, 50, 50, 50);
+               PdfWriter writer;
+               try {
+                       File resFile = new File(resultPath);
+                       File resFolder = new File(resultPath.substring(0, resultPath
+                                       .lastIndexOf(File.separator)));
+                       resFolder.mkdirs();
+                       writer = PdfWriter.getInstance(document, new FileOutputStream(
+                                       resFile));
+
+                       document.open();
+                       PdfContentByte cb = writer.getDirectContent();
+                       PdfTemplate tp = cb.createTemplate(x, y);
+                       Graphics2D g2 = tp.createGraphics(x, y, new DefaultFontMapper());
+                       chart.draw(g2, new java.awt.Rectangle(x, y));
+                       g2.dispose();
+                       cb.addTemplate(tp, 0, 0);
+                       document.close();
+
+               } catch (FileNotFoundException e) {
+                       LOG.error("Sorry, the file is not found.", e);
+               } catch (DocumentException e) {
+                       LOG.error("Sorry, the DocumentException is thrown.", e);
+               }
+       
+               return resultPath;
+       }
+       
+       /** 
+        * {@inheritDoc}
+        * @see org.splat.service.StudyService#getReaders(long)
+        */
+       @Transactional(readOnly = true)
+       public List<UserDTO> getReaders(final long studyId) throws InvalidParameterException {
+               Study aStudy = selectStudy(studyId);
+               if(aStudy == null){
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
+               }
+               List<Relation> relations = aStudy.getRelations(ReaderRelation.class);
+               List<UserDTO> result = new ArrayList<UserDTO>();
+               for(Relation relation : relations){
+                       result.add(BeanHelper.copyBean(relation.getTo(), UserDTO.class));
+               }
+               return Collections.unmodifiableList(result);
+       }
+       
+       /** 
+        * {@inheritDoc}
+        * @see org.splat.service.StudyService#addReader(long, long)
+        */
+       @Transactional
+       public boolean addReader(final long studyId, final long userId) throws InvalidParameterException {
+               Study aStudy = selectStudy(studyId);
+               if(aStudy == null){
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
+               }
+               User user = _userService.selectUser(userId);
+               if(user == null){
+                       throw new InvalidParameterException("userId", String.valueOf(userId));
+               }
+
+               for(Relation relation : aStudy.getRelations(ReaderRelation.class)) {
+                       if(user.equals(relation.getTo())) {
+                               return false;
+                       }
+               }
+               aStudy.addRelation(new ReaderRelation(aStudy, user));
+               update(aStudy);
+               return true;
+       }
+
+       /** 
+        * {@inheritDoc}
+        * @see org.splat.service.StudyService#removeReader(long, long)
+        */
+       @Transactional
+       public boolean removeReader(final long studyId, final long userId) throws InvalidParameterException {
+               Study aStudy = selectStudy(studyId);
+               if(aStudy == null){
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
+               }
+               User user = _userService.selectUser(userId);
+               if(user == null){
+                       throw new InvalidParameterException("userId", String.valueOf(userId));
+               }
+
+               Relation relation = aStudy.removeRelation(ReaderRelation.class, user);
+               update(aStudy);
+               return relation != null;
+       }
+       
        /**
         * Get project settings.
         * 
@@ -1321,9 +1609,112 @@ public class StudyServiceImpl implements StudyService {
        public void setUserService(final UserService userService) {
                _userService = userService;
        }
-       
+
+       /**
+        * {@inheritDoc}
+        * 
+        * @see org.splat.service.StudyService#getComparableStudies()
+        */
+       @Transactional(readOnly = true)
+       public List<StudyFacadeDTO> getComparableStudies(final long userId)
+                       throws MismatchException {
+               // retrieve the number of the "Analyze the results" step
+               List<Step> allSteps = _projectSettings.getAllSteps();
+               Step theAnalyzeStep = null;
+               for (Step step : allSteps) {
+                       if (step.getKey().equals("postprocessing")) {
+                               theAnalyzeStep = step;
+                       }
+               }
+               if (theAnalyzeStep == null) { // TODO: throw some other exception
+                       throw new MismatchException(
+                                       "no step with key 'postprocessing' found."
+                                                       + "Probably, customization settings have been changed.");
+               }
+
+               List<Publication> publications = _publicationDAO.getFilteredList(
+                               "mydoc", Restrictions.eq("step", Integer.valueOf(theAnalyzeStep
+                                               .getNumber())));
+
+               // split retrieved publications into groups by studies and scenarios
+               Map<Study, List<ProjectElement>> studyMap = new HashMap<Study, List<ProjectElement>>();
+               Map<ProjectElement, List<Publication>> scenarioMap = new HashMap<ProjectElement, List<Publication>>();
+
+               for (Publication publication : publications) {
+                       // filter out publications corresponding to a document of given step which is not a _result_ document
+                       if (!publication.value().getType().isResultOf(theAnalyzeStep)
+                                       || !"srd".equals(publication.getSourceFile().getFormat())) {
+                               continue;
+                       }
+
+                       // check the study visibility to the user
+                       if (!isStaffedBy(publication.getOwnerStudy(), _userService
+                                       .selectUser(userId))
+                                       && Visibility.PUBLIC.equals(publication.getOwnerStudy()
+                                                       .getVisibility())) {
+                               continue;
+                       }
+
+                       Study study = publication.getOwnerStudy();
+                       ProjectElement scenario = publication.getOwner();
+
+                       Hibernate.initialize(scenario);
+                       if (scenario instanceof HibernateProxy) {
+                               scenario = (ProjectElement) ((HibernateProxy) scenario)
+                                               .getHibernateLazyInitializer().getImplementation();
+                       }
+
+                       if (!(scenario instanceof Scenario)) {
+                               throw new MismatchException(
+                                               "publications from postprocessing step are supposed to have owner scenario");
+                       }
+
+                       if (!studyMap.containsKey(study)) {
+                               studyMap.put(study, new ArrayList<ProjectElement>());
+                       }
+
+                       if (!studyMap.get(study).contains(scenario)) {
+                               studyMap.get(study).add(scenario);
+                       }
+
+                       if (!scenarioMap.containsKey(scenario)) {
+                               scenarioMap.put(scenario, new ArrayList<Publication>());
+                       }
+                       scenarioMap.get(scenario).add(publication);
+               }
+
+               // Create the result DTOs
+               List<StudyFacadeDTO> result = new ArrayList<StudyFacadeDTO>();
+               for (Study study : studyMap.keySet()) {
+
+                       StudyFacadeDTO studyDTO = new StudyFacadeDTO();
+                       studyDTO.setName(study.getTitle());
+                       studyDTO.setScenarios(new ArrayList<StudyFacadeDTO.ScenarioDTO>());
+                       result.add(studyDTO);
+
+                       for (ProjectElement scenario : studyMap.get(study)) {
+
+                               StudyFacadeDTO.ScenarioDTO scenarioDTO = new StudyFacadeDTO.ScenarioDTO();
+                               scenarioDTO.setName(scenario.getTitle());
+                               scenarioDTO.setDocs(new ArrayList<DocumentDTO>());
+                               studyDTO.getScenarios().add(scenarioDTO);
+
+                               for (Publication publication : scenarioMap.get(scenario)) {
+
+                                       DocumentDTO documentDTO = new DocumentDTO();
+                                       documentDTO.setId(publication.getIndex());
+                                       documentDTO.setTitle(publication.value().getTitle());
+
+                                       scenarioDTO.getDocs().add(documentDTO);
+                               }
+                       }
+               }
+               return result;
+       }
+
        /**
         * Get the publicationDAO.
+        * 
         * @return the publicationDAO
         */
        public PublicationDAO getPublicationDAO() {
@@ -1332,7 +1723,9 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Set the publicationDAO.
-        * @param publicationDAO the publicationDAO to set
+        * 
+        * @param publicationDAO
+        *            the publicationDAO to set
         */
        public void setPublicationDAO(final PublicationDAO publicationDAO) {
                _publicationDAO = publicationDAO;
@@ -1340,6 +1733,7 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Get the repositoryService.
+        * 
         * @return the repositoryService
         */
        public RepositoryService getRepositoryService() {
@@ -1348,7 +1742,9 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Set the repositoryService.
-        * @param repositoryService the repositoryService to set
+        * 
+        * @param repositoryService
+        *            the repositoryService to set
         */
        public void setRepositoryService(final RepositoryService repositoryService) {
                _repositoryService = repositoryService;
@@ -1356,6 +1752,7 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Get the documentDAO.
+        * 
         * @return the documentDAO
         */
        public DocumentDAO getDocumentDAO() {
@@ -1364,7 +1761,9 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Set the documentDAO.
-        * @param documentDAO the documentDAO to set
+        * 
+        * @param documentDAO
+        *            the documentDAO to set
         */
        public void setDocumentDAO(final DocumentDAO documentDAO) {
                _documentDAO = documentDAO;
@@ -1372,6 +1771,7 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Get the descriptionAttributeDAO.
+        * 
         * @return the descriptionAttributeDAO
         */
        public DescriptionAttributeDAO getDescriptionAttributeDAO() {
@@ -1380,10 +1780,32 @@ public class StudyServiceImpl implements StudyService {
 
        /**
         * Set the descriptionAttributeDAO.
-        * @param descriptionAttributeDAO the descriptionAttributeDAO to set
+        * 
+        * @param descriptionAttributeDAO
+        *            the descriptionAttributeDAO to set
         */
        public void setDescriptionAttributeDAO(
                        final DescriptionAttributeDAO descriptionAttributeDAO) {
                _descriptionAttributeDAO = descriptionAttributeDAO;
        }
+
+       /**
+        * Get the usedByRelationDAO.
+        * 
+        * @return the usedByRelationDAO
+        */
+       public UsedByRelationDAO getUsedByRelationDAO() {
+               return _usedByRelationDAO;
+       }
+
+       /**
+        * Set the usedByRelationDAO.
+        * 
+        * @param usedByRelationDAO
+        *            the usedByRelationDAO to set
+        */
+       public void setUsedByRelationDAO(final UsedByRelationDAO usedByRelationDAO) {
+               _usedByRelationDAO = usedByRelationDAO;
+       }
+
 }