Salome HOME
The draft of the "Copy from existing study" action is added. The YACS step is introdu...
[tools/siman.git] / Workspace / Siman-Common / src / org / splat / service / StudyServiceImpl.java
index 3b2e9a386750698297deaad771ab37ad7d3f41b9..d6bf598962b848b99a8c3eabad3be6d38c9481c9 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,8 +48,8 @@ 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.Scenario;
 import org.splat.dal.bo.som.SimulationContext;
@@ -40,20 +60,41 @@ 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.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.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.
  * 
@@ -67,6 +108,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.
@@ -81,7 +126,7 @@ public class StudyServiceImpl implements StudyService {
        /**
         * Injected project service.
         */
-       private ProjectSettingsService _projectSettingsService;
+       private ProjectSettingsService _projectSettings;
 
        /**
         * Injected project element service.
@@ -93,6 +138,11 @@ public class StudyServiceImpl implements StudyService {
         */
        private StudyDAO _studyDAO;
 
+       /**
+        * Injected usedBy relations DAO.
+        */
+       private UsedByRelationDAO _usedByRelationDAO;
+
        /**
         * Injected scenario DAO.
         */
@@ -118,6 +168,26 @@ public class StudyServiceImpl implements StudyService {
         */
        private UserService _userService;
 
+       /**
+        * Injected publication DAO.
+        */
+       private PublicationDAO _publicationDAO;
+
+       /**
+        * Injected repository service.
+        */
+       private RepositoryService _repositoryService;
+
+       /**
+        * Injected document DAO.
+        */
+       private DocumentDAO _documentDAO;
+
+       /**
+        * Injected description attribute DAO.
+        */
+       private DescriptionAttributeDAO _descriptionAttributeDAO;
+
        /**
         * {@inheritDoc}
         * 
@@ -130,6 +200,60 @@ public class StudyServiceImpl implements StudyService {
                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.
         * 
@@ -159,14 +283,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;
        }
 
@@ -205,6 +329,7 @@ public class StudyServiceImpl implements StudyService {
         * 
         * @see org.splat.service.StudyService#addContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User)
         */
+       @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();) {
@@ -219,7 +344,6 @@ public class StudyServiceImpl implements StudyService {
                if (absent) {
                        update(aStudy); // Else, useless to re-index the study
                }
-               contributor.add(user);
                return true;
        }
 
@@ -287,12 +411,13 @@ public class StudyServiceImpl implements StudyService {
                }
                return false;
        }
-*/
+        */
        /**
         * {@inheritDoc}
         * 
         * @see org.splat.service.StudyService#removeContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User[])
         */
+       @Transactional
        public boolean removeContributor(final Study aStudy, final User... users) {
                List<User> contributor = getModifiableContributors(aStudy); // Initializes contributor
                Boolean done = false;
@@ -336,15 +461,16 @@ public class StudyServiceImpl implements StudyService {
         *      org.splat.dal.bo.som.ValidationCycle.Properties)
         */
        @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);
 
@@ -361,8 +487,8 @@ public class StudyServiceImpl implements StudyService {
                                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:",
+                       } catch (BusinessException error) {
+                               LOG.error("Unable to create validation cycle, reason:",
                                                error);
                                return;
                        }
@@ -409,6 +535,7 @@ public class StudyServiceImpl implements StudyService {
         *            a study to promote
         * @return true if the demotion succeeded.
         */
+       @Transactional
        public boolean promote(final Study aStudy) {
                if (aStudy.getProgressState() == ProgressState.inWORK) {
                        aStudy.setProgressState(ProgressState.inDRAFT);
@@ -436,6 +563,7 @@ public class StudyServiceImpl implements StudyService {
         * @return true if the move succeeded.
         * @see #isPublic()
         */
+       @Transactional
        public boolean moveToPublic(final Study aStudy) {
                boolean isOk = false;
                if (aStudy.getVisibility() == Visibility.PRIVATE) {
@@ -447,6 +575,25 @@ public class StudyServiceImpl implements StudyService {
                return isOk;
        }
 
+       /**
+        * Moves this study from the Public to the Private area of the repository.
+        * 
+        * @param aStudy
+        *            a study to move
+        * @return true if the move succeeded.
+        */
+       @Transactional
+       public boolean moveToPrivate(final Study aStudy) {
+               boolean isOk = false;
+               if (aStudy.getVisibility() == Visibility.PUBLIC) {
+                       aStudy.setVisibility(Visibility.PRIVATE);
+                       if (update(aStudy)) {
+                               isOk = updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
+                       }
+               }
+               return isOk;
+       }
+
        /**
         * Update a study in the database.
         * 
@@ -458,9 +605,9 @@ public class StudyServiceImpl implements StudyService {
        private boolean update(final Study aStudy) {
                boolean isOk = false;
                try {
-                       getStudyDAO().update(aStudy); // Update of relational base
+                       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());
@@ -520,7 +667,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++) {
@@ -608,25 +755,26 @@ 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 (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;
+               return true;
        }
 
        /**
@@ -638,6 +786,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
                }
@@ -842,7 +995,8 @@ public class StudyServiceImpl implements StudyService {
         */
        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(
@@ -979,13 +1133,232 @@ public class StudyServiceImpl implements StudyService {
                }
        }
 
+       /**
+        * 
+        * {@inheritDoc}
+        * 
+        * @see org.splat.service.StudyService#markStudyAsReference(org.splat.dal.bo.som.Study)
+        */
+       @Override
+       @Transactional
+       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(PARAM_STUDY_ID, "null");
+               }
+               Study study = _studyDAO.get(studyId);
+               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)
+                       throws InvalidParameterException {
+               if (studyId == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, "null");
+               }
+               Study study = _studyDAO.get(studyId);
+               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(PARAM_STUDY_ID, String
+                                       .valueOf(studyId));
+               }
+               Study study = _studyDAO.get(studyId);
+               if (study == null) {
+                       throw new InvalidParameterException(PARAM_STUDY_ID, String
+                                       .valueOf(studyId));
+               }
+               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;
+       }
+
        /**
         * Get project settings.
         * 
         * @return Project settings service
         */
        private ProjectSettingsService getProjectSettings() {
-               return _projectSettingsService;
+               return _projectSettings;
        }
 
        /**
@@ -996,7 +1369,7 @@ public class StudyServiceImpl implements StudyService {
         */
        public void setProjectSettings(
                        final ProjectSettingsService projectSettingsService) {
-               _projectSettingsService = projectSettingsService;
+               _projectSettings = projectSettingsService;
        }
 
        /**
@@ -1172,4 +1545,199 @@ 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() {
+               return _publicationDAO;
+       }
+
+       /**
+        * Set the publicationDAO.
+        * 
+        * @param publicationDAO
+        *            the publicationDAO to set
+        */
+       public void setPublicationDAO(final PublicationDAO publicationDAO) {
+               _publicationDAO = publicationDAO;
+       }
+
+       /**
+        * Get the repositoryService.
+        * 
+        * @return the repositoryService
+        */
+       public RepositoryService getRepositoryService() {
+               return _repositoryService;
+       }
+
+       /**
+        * Set the repositoryService.
+        * 
+        * @param repositoryService
+        *            the repositoryService to set
+        */
+       public void setRepositoryService(final RepositoryService repositoryService) {
+               _repositoryService = repositoryService;
+       }
+
+       /**
+        * Get the documentDAO.
+        * 
+        * @return the documentDAO
+        */
+       public DocumentDAO getDocumentDAO() {
+               return _documentDAO;
+       }
+
+       /**
+        * Set the documentDAO.
+        * 
+        * @param documentDAO
+        *            the documentDAO to set
+        */
+       public void setDocumentDAO(final DocumentDAO documentDAO) {
+               _documentDAO = documentDAO;
+       }
+
+       /**
+        * Get the descriptionAttributeDAO.
+        * 
+        * @return the descriptionAttributeDAO
+        */
+       public DescriptionAttributeDAO getDescriptionAttributeDAO() {
+               return _descriptionAttributeDAO;
+       }
+
+       /**
+        * Set the descriptionAttributeDAO.
+        * 
+        * @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;
+       }
+
 }