1 /*****************************************************************************
5 * Creation date 02.10.2012
6 * @author Author: Maria KRUCHININA
8 *****************************************************************************/
10 package org.splat.service;
12 import java.awt.Graphics2D;
14 import java.io.FileNotFoundException;
15 import java.io.FileOutputStream;
16 import java.io.IOException;
17 import java.text.DecimalFormat;
18 import java.text.SimpleDateFormat;
19 import java.util.ArrayList;
20 import java.util.Calendar;
21 import java.util.Collections;
22 import java.util.Date;
23 import java.util.HashMap;
24 import java.util.HashSet;
25 import java.util.Iterator;
26 import java.util.List;
28 import java.util.Scanner;
31 import org.apache.lucene.index.IndexWriter;
32 import org.apache.lucene.store.FSDirectory;
33 import org.hibernate.Criteria;
34 import org.hibernate.Hibernate;
35 import org.hibernate.criterion.DetachedCriteria;
36 import org.hibernate.criterion.Restrictions;
37 import org.hibernate.proxy.HibernateProxy;
38 import org.jfree.chart.ChartFactory;
39 import org.jfree.chart.JFreeChart;
40 import org.jfree.chart.plot.PlotOrientation;
41 import org.jfree.data.xy.XYSeries;
42 import org.jfree.data.xy.XYSeriesCollection;
43 import org.splat.common.properties.MessageKeyEnum;
44 import org.splat.dal.bo.kernel.Relation;
45 import org.splat.dal.bo.kernel.User;
46 import org.splat.dal.bo.som.ActorRelation;
47 import org.splat.dal.bo.som.ContributorRelation;
48 import org.splat.dal.bo.som.DescriptionAttribute;
49 import org.splat.dal.bo.som.DocumentType;
50 import org.splat.dal.bo.som.IDBuilder;
51 import org.splat.dal.bo.som.ProgressState;
52 import org.splat.dal.bo.som.ProjectElement;
53 import org.splat.dal.bo.som.Publication;
54 import org.splat.dal.bo.som.ReaderRelation;
55 import org.splat.dal.bo.som.Scenario;
56 import org.splat.dal.bo.som.SimulationContext;
57 import org.splat.dal.bo.som.Study;
58 import org.splat.dal.bo.som.ValidationCycle;
59 import org.splat.dal.bo.som.ValidationCycleRelation;
60 import org.splat.dal.bo.som.ValidationStep;
61 import org.splat.dal.bo.som.Visibility;
62 import org.splat.dal.bo.som.Study.Properties;
63 import org.splat.dal.bo.som.ValidationCycle.Actor;
64 import org.splat.dal.dao.som.DescriptionAttributeDAO;
65 import org.splat.dal.dao.som.DocumentDAO;
66 import org.splat.dal.dao.som.IDBuilderDAO;
67 import org.splat.dal.dao.som.PublicationDAO;
68 import org.splat.dal.dao.som.ScenarioDAO;
69 import org.splat.dal.dao.som.StudyDAO;
70 import org.splat.dal.dao.som.UsedByRelationDAO;
71 import org.splat.dal.dao.som.ValidationCycleDAO;
72 import org.splat.exception.BusinessException;
73 import org.splat.exception.IncompatibleDataException;
74 import org.splat.exception.InvalidParameterException;
75 import org.splat.kernel.InvalidPropertyException;
76 import org.splat.kernel.MismatchException;
77 import org.splat.kernel.MissedPropertyException;
78 import org.splat.kernel.MultiplyDefinedException;
79 import org.splat.log.AppLogger;
80 import org.splat.service.dto.DocToCompareDTO;
81 import org.splat.service.dto.DocumentDTO;
82 import org.splat.service.dto.StudyFacadeDTO;
83 import org.splat.service.dto.UserDTO;
84 import org.splat.service.technical.IndexService;
85 import org.splat.service.technical.ProjectSettingsService;
86 import org.splat.service.technical.ProjectSettingsServiceImpl;
87 import org.splat.service.technical.RepositoryService;
88 import org.splat.service.technical.ProjectSettingsService.Step;
89 import org.splat.som.Revision;
90 import org.splat.util.BeanHelper;
91 import org.springframework.transaction.annotation.Transactional;
93 import com.lowagie.text.Document;
94 import com.lowagie.text.DocumentException;
95 import com.lowagie.text.Rectangle;
96 import com.lowagie.text.pdf.DefaultFontMapper;
97 import com.lowagie.text.pdf.PdfContentByte;
98 import com.lowagie.text.pdf.PdfTemplate;
99 import com.lowagie.text.pdf.PdfWriter;
102 * This class defines all methods for creation, modification the study.
104 * @author Maria KRUCHININA
107 public class StudyServiceImpl implements StudyService {
110 * logger for the service.
112 public final static AppLogger LOG = AppLogger
113 .getLogger(StudyServiceImpl.class);
115 * "studyId" parameter name.
117 public final static String PARAM_STUDY_ID = "studyId";
120 * Injected index service.
122 private IndexService _indexService;
125 * Injected step service.
127 private StepService _stepService;
130 * Injected project service.
132 private ProjectSettingsService _projectSettings;
135 * Injected project element service.
137 private ProjectElementService _projectElementService;
140 * Injected study DAO.
142 private StudyDAO _studyDAO;
145 * Injected usedBy relations DAO.
147 private UsedByRelationDAO _usedByRelationDAO;
150 * Injected scenario DAO.
152 private ScenarioDAO _scenarioDAO;
155 * Injected validation cycle DAO.
157 private ValidationCycleDAO _validationCycleDAO;
160 * Injected IDBuilder DAO.
162 private IDBuilderDAO _iDBuilderDAO;
165 * Injected document type service.
167 private DocumentTypeService _documentTypeService;
170 * Injected user service.
172 private UserService _userService;
175 * Injected publication DAO.
177 private PublicationDAO _publicationDAO;
180 * Injected repository service.
182 private RepositoryService _repositoryService;
185 * Injected document DAO.
187 private DocumentDAO _documentDAO;
190 * Injected description attribute DAO.
192 private DescriptionAttributeDAO _descriptionAttributeDAO;
197 * @see org.splat.service.StudyService#selectStudy(long)
200 public Study selectStudy(final long index) {
201 Study result = getStudyDAO().get(index);
202 if (result != null) {
203 loadWorkflow(result);
211 * @see org.splat.service.StudyService#removeStudy(long)
214 public void removeStudy(final Long index) {
215 Study study = getStudyDAO().get(index);
216 Set<org.splat.dal.bo.som.Document> docums = new HashSet<org.splat.dal.bo.som.Document>();
218 // Select all documents published in the study and study's scenarios.
219 DetachedCriteria query = DetachedCriteria.forClass(
220 Publication.class, "pub");
222 .createCriteria("pub.owner", "projelem",
224 .createAlias("projelem.owner", "study", Criteria.LEFT_JOIN)
227 .or(Restrictions.eq("projelem.rid", index),
228 Restrictions.eq("study.rid", index)))
229 .setResultTransformer(Criteria.DISTINCT_ROOT_ENTITY);
231 if (LOG.isDebugEnabled()) {
232 LOG.debug("Find study documents: " + query.toString());
234 for (Publication pub : getPublicationDAO().getFilteredList(query)) {
235 docums.add(pub.value());
236 // Find also all previous versions of the document
237 for (org.splat.dal.bo.som.Document prev = pub.value()
238 .getPreviousVersion(); prev != null; prev = prev
239 .getPreviousVersion()) {
244 // Delete the study with its relations, scenarios and publications
245 getStudyDAO().delete(study);
247 // Remove all relations of study documents
248 for (org.splat.dal.bo.som.Document doc : docums) {
249 LOG.debug("Found doc: " + doc.getTitle() + " ["
250 + doc.getReference() + "]" + " [" + doc.getRid() + "]");
251 doc.getAllRelations().clear();
253 getDocumentDAO().flush();
255 // Remove all documents of the study
256 for (org.splat.dal.bo.som.Document doc : docums) {
257 LOG.debug("Remove doc: " + doc.getTitle() + " ["
258 + doc.getReference() + "]" + " [" + doc.getRid() + "]");
259 getDocumentDAO().delete(doc);
265 * Get study by its reference.
268 * the study reference
269 * @return found study or null
271 @Transactional(readOnly = true)
272 public Study selectStudy(final String refid) {
273 Study result = getStudyDAO().findByCriteria(
274 Restrictions.eq("sid", refid));
275 loadWorkflow(result);
282 * @see org.splat.service.StudyService#createStudy(org.splat.dal.bo.som.Study.Properties)
285 public Study createStudy(final Study.Properties sprop)
286 throws MissedPropertyException, InvalidPropertyException,
287 MultiplyDefinedException {
288 sprop.setReference(getProjectSettings().getReferencePattern());
289 Study study = new Study(sprop);
291 buildReference(study);
292 getStudyDAO().create(study);
294 // IndexService lucin = getIndex();
296 // } catch (IOException error) {
297 // LOG.error("Unable to index the study '" + study.getIndex()
298 // + "', reason:", error);
299 // // Continue and try to index later
307 * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext.Properties)
310 public SimulationContext addProjectContext(final Study aStudy,
311 final SimulationContext.Properties cprop)
312 throws MissedPropertyException, InvalidPropertyException,
313 MultiplyDefinedException {
314 SimulationContext added = getStepService().addSimulationContext(
315 getProjectElementService().getFirstStep(aStudy), cprop);
323 * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
326 public SimulationContext addProjectContext(final Study aStudy,
327 final SimulationContext context) {
328 SimulationContext added = getStepService().addSimulationContext(
329 getProjectElementService().getFirstStep(aStudy), context);
337 * @see org.splat.service.StudyService#addContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User)
340 public boolean addContributor(final Study aStudy, final User user) {
341 List<User> contributors = getModifiableContributors(aStudy); // Initializes contributor
343 if(contributors.contains(user)) {
347 //Remove user from readers
349 List<UserDTO> readers = getReaders(aStudy.getIndex());
350 for(UserDTO reader : readers) {
351 if(reader.getIndex() == user.getIndex()) {
352 //user must be the actual user in the relationship object in the aStudy object for this to work
353 aStudy.removeRelation(ReaderRelation.class, user);
356 } catch(InvalidParameterException e) {
357 LOG.error(e.getMessage(), e);
360 boolean absent = getModifiableActors(aStudy).add(user); // User may already be a reviewer or an approver
362 aStudy.addRelation(new ContributorRelation(aStudy, user));
364 update(aStudy); // Else, useless to re-index the study
370 * Moves this study from the Public to the Reference area of the repository. For being moved to the Reference area, the study must
371 * previously be approved.
375 * @return true if the move succeeded.
376 * @see #moveToPublic()
378 * @see Publication#approve(Date)
381 public boolean moveToReference(final Study aStudy) {
382 if (aStudy.getProgressState() != ProgressState.APPROVED) {
385 if (aStudy.getVisibility() != Visibility.PUBLIC) {
389 aStudy.setVisibility(Visibility.REFERENCE);
390 if (update(aStudy)) {
391 return updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
399 * @see org.splat.service.StudyService#update(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.Study.Properties)
402 public boolean update(final Study aStudy, final Properties sprop)
403 throws InvalidPropertyException {
404 if (sprop.getTitle() != null) {
405 aStudy.setTitle(sprop.getTitle());
407 if (sprop.getSummary() != null) {
408 aStudy.setAttribute(new DescriptionAttribute(aStudy, sprop
411 // TODO: To be completed
412 return update(aStudy);
416 * Check if the document is published in the study.
422 * @return true if the document is published in the study
425 * private boolean publishes(final Study aStudy, final Document doc) { if (!aStudy.publishes(doc)) { Scenario[] scene =
426 * aStudy.getScenarii(); for (int i = 0; i < scene.length; i++) { if (scene[i].publishes(doc)) { return true; } } } return false; }
431 * @see org.splat.service.StudyService#removeContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User[])
434 public boolean removeContributor(final Study aStudy, final User... users) {
435 List<User> contributors = getModifiableContributors(aStudy); // Initializes contributor
436 Boolean done = false;
437 for(User user : users) {
438 if(contributors.contains(user)) {
439 aStudy.removeRelation(ContributorRelation.class, user);
440 contributors.remove(user);
453 * @see org.splat.service.StudyService#removeProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
456 public boolean removeProjectContext(final Study aStudy,
457 final SimulationContext context) {
458 boolean done = getStepService().removeSimulationContext(
459 getProjectElementService().getFirstStep(aStudy), context);
467 * @see org.splat.service.StudyService#setValidationCycle(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.DocumentType,
468 * org.splat.dal.bo.som.ValidationCycle.Properties)
471 public void setValidationCycle(final Study aStudyDTO,
472 final DocumentType type, final ValidationCycle.Properties vprop) {
473 Map<String, ValidationCycle> validactor = aStudyDTO
474 .getValidationCycles();
475 if (validactor == null) {
476 setShortCuts(aStudyDTO); // Initializes validactor and actor
479 Study aStudy = selectStudy(aStudyDTO.getIndex());
481 String cname = type.getName();
482 ValidationCycle cycle = validactor.get(cname);
484 if (cycle != null && cycle.isAssigned()) {
485 resetActors(cycle, vprop);
488 cycle = new ValidationCycle(aStudy, vprop.setDocumentType(type));
490 getValidationCycleDAO().create(cycle); // RKV
492 ValidationCycleRelation link = cycle.getContext();
493 aStudy.addRelation(link);
494 getValidationCycleDAO().flush();
495 aStudyDTO.getAllRelations().add(link); // RKV
497 validactor.put(cname, link.getTo()); // Replaces the cycle if exists as default,
498 } catch (BusinessException error) {
499 LOG.error("Unable to create validation cycle, reason:", error);
503 resetActorsShortCut(aStudyDTO);
504 update(aStudy); // Re-index the study, just in case
508 * Demotes this study from In-Check to In-Draft then In-Work states. This function is called internally when demoting the final result
509 * document of the study.
513 * @return true if the demotion succeeded.
516 public boolean demote(final Study aStudy) {
517 if (aStudy.getProgressState() == ProgressState.inCHECK) {
518 aStudy.setProgressState(ProgressState.inDRAFT);
519 } else if (aStudy.getProgressState() == ProgressState.inDRAFT) {
520 aStudy.setProgressState(ProgressState.inWORK);
524 return update(aStudy);
530 * @see org.splat.service.StudyService#generateLocalIndex(org.splat.dal.bo.som.Study)
533 public int generateLocalIndex(final Study aStudy) {
534 aStudy.setLastLocalIndex(aStudy.getLastLocalIndex() + 1);
535 return aStudy.getLastLocalIndex();
539 * Promotes this study from In-Work to In-Draft then In-Check and APPROVED states. This function is called internally when promoting the
540 * final result document of the study.
544 * @return true if the demotion succeeded.
547 public boolean promote(final Study aStudy) {
548 if (aStudy.getProgressState() == ProgressState.inWORK) {
549 aStudy.setProgressState(ProgressState.inDRAFT);
550 } else if (aStudy.getProgressState() == ProgressState.inDRAFT) {
551 aStudy.setProgressState(ProgressState.inCHECK);
552 Revision myvers = new Revision(aStudy.getVersion());
553 if (myvers.isMinor()) {
554 aStudy.setVersion(myvers.incrementAs(aStudy.getProgressState())
557 } else if (aStudy.getProgressState() == ProgressState.inCHECK) {
558 aStudy.setProgressState(ProgressState.APPROVED);
563 return update(aStudy);
567 * Moves this study from the Private to the Public area of the repository.
571 * @return true if the move succeeded.
575 public boolean moveToPublic(final Study aStudy) {
576 boolean isOk = false;
577 if (aStudy.getVisibility() == Visibility.PRIVATE) {
578 aStudy.setVisibility(Visibility.PUBLIC);
579 if (update(aStudy)) {
580 isOk = updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
587 * Moves this study from the Public to the Private area of the repository.
591 * @return true if the move succeeded.
594 public boolean moveToPrivate(final Study aStudy) {
595 boolean isOk = false;
596 if (aStudy.getVisibility() == Visibility.PUBLIC) {
597 aStudy.setVisibility(Visibility.PRIVATE);
598 if (update(aStudy)) {
599 isOk = updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
606 * Update a study in the database.
609 * the study to update
610 * @return true if the study is updated successfully
612 private boolean update(final Study aStudy) {
613 boolean isOk = false;
615 getStudyDAO().merge(aStudy); // Update of relational base
616 setShortCuts(aStudy); // RKV: initialize transient actors set
617 //RKV: getIndex().update(aStudy); // Update of Lucene index
619 } catch (Exception e) {
620 LOG.error("STD-000001", e, aStudy.getIndex(), e.getMessage());
626 * Build reference for the study. The reference of the study is stored as a new reference pattern (IDBuilder).
630 * @return true if reference building is succeded
633 private boolean buildReference(final Study aStudy) {
634 String pattern = aStudy.getReference(); // The study being supposed just created, its reference is the reference pattern
635 IDBuilder tool = selectIDBuilder(aStudy.getDate());
637 tool = new IDBuilder(aStudy.getDate());
638 getIDBuilderDAO().create(tool);
640 aStudy.setReference(buildReference(tool, pattern, aStudy));
645 * Build reference for the study. The reference of the study is stored as a new reference pattern (IDBuilder).
652 * the reference pattern
653 * @return true if reference building is succeded
656 public String buildReference(final IDBuilder aBuilder,
657 final String pattern, final Study study) {
658 char[] format = pattern.toCharArray();
659 char[] ref = new char[80]; // Better evaluate the length of the generated string
660 int next = aBuilder.getBase() + 1;
663 for (int i = 0; i < format.length; i++) {
665 // Insertion of attribute values
666 if (format[i] == '%') {
669 if (format[i] == 'y') { // Insertion of year in format 2 (e.g. 09) or 4 (e.g. 2009) digits
671 while (format[i] == 'y') {
673 if (i == format.length) {
677 SimpleDateFormat tostring = new SimpleDateFormat("yyyy"); // RKV: NOPMD: TODO: Use locale here?
678 String year = tostring.format(study.getDate());
679 year = year.substring(4 - (i - n), 4); // 4-(i-n) must be equal to either 0 or 2
680 for (int j = 0; j < year.length(); j++) {
681 ref[count] = year.charAt(j);
684 i -= 1; // Back to the last 'y' character
685 } else if (format[i] == '0') { // Insertion of the index
687 while (format[i] == '0') {
689 if (i == format.length) {
693 DecimalFormat tostring = new DecimalFormat(pattern
695 String number = tostring.format(next);
696 for (int j = 0; j < number.length(); j++) {
697 ref[count] = number.charAt(j);
700 i -= 1; // Back to the last '0' character
702 // Keep the character
704 ref[count] = format[i];
708 // Incrementation of the number of study
709 aBuilder.setBase(next);
710 getIDBuilderDAO().update(aBuilder);
711 return String.copyValueOf(ref, 0, count);
715 * Find an id builder by date.
719 * @return found id builder
721 private IDBuilder selectIDBuilder(final Date date) {
722 Calendar aDate = Calendar.getInstance();
724 return getIDBuilderDAO().findByCriteria(
725 Restrictions.eq("cycle", aDate.get(Calendar.YEAR)));
729 * Fill transient collection ModifiableActors of the study.
734 private void resetActorsShortCut(final Study aStudy) {
735 getModifiableActors(aStudy).clear();
736 // Get all actors involved in validation cycles
737 for (Iterator<ValidationCycle> i = aStudy.getValidationCycles()
738 .values().iterator(); i.hasNext();) {
739 ValidationCycle cycle = i.next();
740 User[] user = cycle.getAllActors();
741 for (int j = 0; j < user.length; j++) {
742 getModifiableActors(aStudy).add(user[j]);
745 // Get all other actors
746 for (Iterator<Relation> i = aStudy.getAllRelations().iterator(); i
748 Relation link = i.next();
749 Class<?> kindof = link.getClass().getSuperclass();
750 if (!kindof.equals(ActorRelation.class)) {
753 getModifiableActors(aStudy).add(((ActorRelation) link).getTo());
758 * Update lucene index for the study knowledge elements.
762 * @return true if reindexing succeeded
764 private boolean updateKnowledgeElementsIndex(final Study aStudy) {
765 // boolean isOk = false;
767 // IndexService lucin = getIndex();
768 // for(Scenario scenario : aStudy.getScenariiList()) {
769 // for (KnowledgeElement element : scenario.getAllKnowledgeElements()) {
770 // lucin.update(element);
774 // } catch (Exception error) {
775 // LOG.error("Unable to re-index Knowledge Elements, reason:",
783 * Get lucene index service. Create a lucene index if it does not exist.
785 * @return index service
786 * @throws IOException
787 * if error occurs during lucene index creation
789 private IndexService getIndex() throws IOException {
790 IndexService lucin = getIndexService();
791 if (IndexWriter.isLocked(FSDirectory.open(getRepositoryService()
792 .getRepositoryIndexDirectory()))) {
793 IndexWriter.unlock(FSDirectory.open(getRepositoryService()
794 .getRepositoryIndexDirectory()));
796 if (!lucin.exists()) {
797 lucin.create(); // Happens when re-indexing all studies
803 * Create a new validation cycle for documents of the given study.
808 * the cycle description
809 * @return the new validation cycle
811 protected ValidationCycle createValidationCycle(
813 final ProjectSettingsServiceImpl.ProjectSettingsValidationCycle cycle) {
814 Actor[] actype = cycle.getActorTypes();
815 User.Properties uprop = new User.Properties();
817 ValidationCycle aValidationCycle = new ValidationCycle();
818 aValidationCycle.setDocumentType(getDocumentTypeService().selectType(
819 cycle.getName())); // Null in case of default validation cycle
820 // context = new ValidationCycleRelation(from, vprop);
821 // RKV aValidationCycle.context = null; // Validation cycle defined in the workflow
822 for (int i = 0; i < actype.length; i++) {
824 if (actype[i] != null) {
826 if (actype[i] == Actor.manager) {
827 actor = from.getAuthor();
828 } else if (actype[i] == Actor.Nx1) {
829 List<User> manager = getUserService().selectUsersWhere(
830 uprop.setOrganizationName("Nx1"));
831 if (manager.size() == 1) {
832 actor = manager.get(0);
834 } else if (actype[i] == Actor.Nx2) {
835 List<User> manager = getUserService().selectUsersWhere(
836 uprop.setOrganizationName("Nx2"));
837 if (manager.size() == 1) {
838 actor = manager.get(0);
840 } else { /* Actor.customer */
841 actor = from.getAuthor();
842 // TODO: Get the customer of the study, if exists
844 } catch (Exception e) { // Should not happen
849 aValidationCycle.setReviewer(actor);
851 aValidationCycle.setApprover(actor);
853 aValidationCycle.setSignatory(actor);
856 return aValidationCycle;
860 * Remove a validation step from the validation cycle.
862 * @param aValidationCycle
863 * the validation cycle
865 * the validation step to remove
868 protected void remove(final ValidationCycle aValidationCycle,
869 final ValidationStep step) {
870 if (step == ValidationStep.REVIEW) {
871 aValidationCycle.setReviewer(null);
872 } else if (step == ValidationStep.APPROVAL) {
873 aValidationCycle.setApprover(null);
874 } else if (step == ValidationStep.ACCEPTANCE
875 || step == ValidationStep.REFUSAL) {
876 aValidationCycle.setSignatory(null);
878 if (aValidationCycle.isSaved()) {
879 getValidationCycleDAO().update(aValidationCycle);
884 * Reset actors for the validation cycle.
886 * @param aValidationCycle
887 * the validation cycle to update
889 * new validation cycle properties containing new actors
892 public void resetActors(final ValidationCycle aValidationCycle,
893 final ValidationCycle.Properties vprop) {
894 aValidationCycle.setPublisher(vprop.getPublisher()); // May be null
895 aValidationCycle.setReviewer(vprop.getReviewer()); // May be null
896 aValidationCycle.setApprover(vprop.getApprover()); // May be null
897 aValidationCycle.setSignatory(vprop.getSignatory()); // May be null
898 if (aValidationCycle.isSaved()) {
899 getValidationCycleDAO().merge(aValidationCycle);
904 * Set actor for the given validation cycle and validation step.
906 * @param aValidationCycle
907 * the validation cycle
909 * the validation step
914 protected void setActor(final ValidationCycle aValidationCycle,
915 final ValidationStep step, final User actor) {
916 if (step == ValidationStep.PROMOTION) {
917 aValidationCycle.setPublisher(actor);
918 } else if (step == ValidationStep.REVIEW) {
919 aValidationCycle.setReviewer(actor);
920 } else if (step == ValidationStep.APPROVAL) {
921 aValidationCycle.setApprover(actor);
922 } else if (step == ValidationStep.ACCEPTANCE
923 || step == ValidationStep.REFUSAL) {
924 aValidationCycle.setSignatory(actor);
926 if (aValidationCycle.isSaved()) {
927 getValidationCycleDAO().update(aValidationCycle);
932 * Returns all actors of this study other than the author, including contributors, reviewers and approvers.
936 * @return the actors of this study
937 * @see #hasActor(User)
939 public Set<User> getActors(final Study aStudy) {
940 if (aStudy.getActor() == null) {
941 setShortCuts(aStudy);
943 return Collections.unmodifiableSet(aStudy.getActor());
947 * Returns all actors of this study other than the author, including contributors, reviewers and approvers.
951 * @return the modifiable set of actors of this study
952 * @see #hasActor(User)
954 public Set<User> getModifiableActors(final Study aStudy) {
955 if (aStudy.getActor() == null) {
956 setShortCuts(aStudy);
958 return aStudy.getActor();
962 * Returns unmodifiable initialized transient list of contributors of this study.
966 * @return the unmodifiable not null transient list of contributors of this study
968 public List<User> getContributors(final Study aStudy) {
969 if (aStudy.getContributor() == null) {
970 setShortCuts(aStudy);
972 return Collections.unmodifiableList(aStudy.getContributor()); // May be empty
976 * Returns modifiable initialized transient list of contributors of this study.
980 * @return the modifiable not null transient list of contributors of this study
982 public List<User> getModifiableContributors(final Study aStudy) {
983 if (aStudy.getContributor() == null) {
984 setShortCuts(aStudy);
986 return aStudy.getContributor(); // May be empty
990 * Returns the validation cycle of the given document type.
995 * the document type being subject of validation
996 * @return the validation cycle of the document, or null if not defined.
998 public ValidationCycle getValidationCycleOf(final Study aStudy,
999 final DocumentType type) {
1000 if (aStudy.getValidationCycles() == null
1001 || aStudy.getValidationCycles().isEmpty()) {
1002 setShortCuts(aStudy);
1004 ValidationCycle result = aStudy.getValidationCycles().get(
1006 if (result == null) {
1007 if (type.isStepResult()) {
1008 result = aStudy.getValidationCycles().get("default"); // "default" validation cycle defined in the configuration, if exist
1010 if (result == null) {
1011 result = aStudy.getValidationCycles().get("built-in");
1018 * Checks if the given user is actor of this study. Actors include contributors, reviewers and approvers.
1023 * the user to look for
1024 * @return true if the given user is actor of this study.
1027 public boolean hasActor(final Study aStudy, final User user) {
1031 for (Iterator<User> i = getActors(aStudy).iterator(); i.hasNext();) {
1032 User involved = i.next();
1033 if (involved.equals(user)) {
1041 * Checks if the given user participates to this study. The Study staff includes the author and contributors.
1046 * the user to look for
1047 * @return true if the given user is actor of this study.
1048 * @see #getContributors()
1050 public boolean isStaffedBy(final Study aStudy, final User user) {
1054 if (aStudy == null) {
1057 if (aStudy.getAuthor() == null) {
1060 if (aStudy.getAuthor().equals(user)) {
1063 for (Iterator<User> i = getContributors(aStudy).iterator(); i.hasNext();) {
1064 if (i.next().equals(user)) {
1072 * Initialize shortcuts of the study as its transient collections.
1077 public void loadWorkflow(final Study aStudy) {
1078 setShortCuts(aStudy);
1082 * Initialize shortcuts of the study as its transient collections.
1087 public void setShortCuts(final Study aStudy) {
1088 aStudy.getContributor().clear();
1089 aStudy.getValidationCycles().clear();
1090 aStudy.getActor().clear();
1092 // Get the contributors
1093 for (Iterator<Relation> i = aStudy.getRelations(
1094 ContributorRelation.class).iterator(); i.hasNext();) {
1095 ContributorRelation link = (ContributorRelation) i.next();
1096 aStudy.getContributor().add(link.getTo());
1098 // Get the validation cycles specific to this study
1099 for (Iterator<Relation> i = aStudy.getRelations(
1100 ValidationCycleRelation.class).iterator(); i.hasNext();) {
1101 ValidationCycleRelation link = (ValidationCycleRelation) i.next();
1102 aStudy.getValidationCycles().put(link.getDocumentType().getName(),
1103 link.getTo()); // The associated document type is necessarily not null in this
1106 // Get the validation cycles coming from the configured workflow and not overridden in this study
1107 for (Iterator<ProjectSettingsServiceImpl.ProjectSettingsValidationCycle> i = getProjectSettings()
1108 .getAllValidationCycles().iterator(); i.hasNext();) {
1109 ProjectSettingsServiceImpl.ProjectSettingsValidationCycle cycle = i
1111 String type = cycle.getName();
1112 if (!aStudy.getValidationCycles().containsKey(type)) {
1113 aStudy.getValidationCycles().put(type,
1114 createValidationCycle(aStudy, cycle));
1117 // Get all corresponding actors
1118 for (Iterator<ValidationCycle> i = aStudy.getValidationCycles()
1119 .values().iterator(); i.hasNext();) {
1120 ValidationCycle cycle = i.next();
1121 User[] user = cycle.getAllActors();
1122 for (int j = 0; j < user.length; j++) {
1123 aStudy.getActor().add(user[j]);
1126 // Get all other actors
1127 for (Iterator<Relation> i = aStudy.getAllRelations().iterator(); i
1129 Relation link = i.next();
1130 Class<?> kindof = link.getClass().getSuperclass();
1131 if (!kindof.equals(ActorRelation.class)) {
1134 aStudy.getActor().add(((ActorRelation) link).getTo());
1142 * @see org.splat.service.StudyService#markStudyAsReference(org.splat.dal.bo.som.Study)
1145 public void markStudyAsReference(final Study aStudy) {
1147 aStudy.setMarkreference(1);
1148 aStudy.setProgressState(ProgressState.TEMPLATE);
1149 getStudyDAO().merge(aStudy);
1156 * @see org.splat.service.StudyService#removeStudyAsReference(org.splat.dal.bo.som.Study)
1159 public void removeStudyAsReference(final Study aStudy) {
1161 aStudy.setMarkreference(0);
1162 aStudy.setProgressState(ProgressState.APPROVED);
1163 getStudyDAO().merge(aStudy);
1169 * @see org.splat.service.StudyService#getDescription(java.lang.Long)
1172 @Transactional(readOnly = true)
1173 public String getDescription(final Long studyId)
1174 throws InvalidParameterException {
1175 if (studyId == null) {
1176 throw new InvalidParameterException(PARAM_STUDY_ID, "null");
1178 Study study = _studyDAO.get(studyId);
1179 if (study == null) {
1180 throw new InvalidParameterException(PARAM_STUDY_ID, studyId
1183 return study.getDescription();
1189 * @see org.splat.service.StudyService#setDescription(java.lang.Long, java.lang.String)
1192 public void setDescription(final Long studyId, final String descriptionText)
1193 throws InvalidParameterException {
1194 if (studyId == null) {
1195 throw new InvalidParameterException(PARAM_STUDY_ID, "null");
1197 Study study = _studyDAO.get(studyId);
1198 if (study == null) {
1199 throw new InvalidParameterException(PARAM_STUDY_ID, studyId
1202 study.setAttribute(new DescriptionAttribute(study, descriptionText));
1208 * @see org.splat.service.StudyService#removeStudyDescription(java.lang.Long)
1211 public boolean removeDescription(final Long studyId)
1212 throws InvalidParameterException {
1213 if (studyId == null) {
1214 throw new InvalidParameterException(PARAM_STUDY_ID, String
1217 Study study = _studyDAO.get(studyId);
1218 if (study == null) {
1219 throw new InvalidParameterException(PARAM_STUDY_ID, String
1222 return study.removeAttribute(study
1223 .getAttribute(DescriptionAttribute.class));
1230 * @see org.splat.service.StudyService#compare(java.util.List)
1233 public String compare(final List<DocToCompareDTO> docsList,
1234 final String userName) throws IncompatibleDataException {
1236 String axis1Name = "";
1237 String axis2Name = "";
1238 String chartTitle = "";
1239 String resultPath = "";
1241 XYSeriesCollection dataset = new XYSeriesCollection();
1243 Iterator<DocToCompareDTO> docListIter = docsList.iterator();
1245 for (; docListIter.hasNext();) {
1247 DocToCompareDTO docDTO = docListIter.next();
1248 String pathToFile = docDTO.getPathToFile();
1249 File compDocFile = new File(pathToFile);
1251 resultPath = pathToFile.substring(0, pathToFile.indexOf("vault"))
1252 + "downloads" + File.separator + userName + File.separator
1253 + "ComparisonResult.pdf";
1255 XYSeries series = new XYSeries("Study: " + docDTO.getStudyTitle()
1256 + " Scenario: " + docDTO.getScenarioTitle() + " Document: "
1257 + docDTO.getDocumentTitle());
1259 // read the file and get points information.
1261 Scanner input = new Scanner(compDocFile);
1263 // get the title of the chart.
1264 if (input.hasNext()) {
1265 chartTitle = input.nextLine();
1268 // get the name of the axis.
1269 if (input.hasNext()) {
1270 String[] tokens = input.nextLine().split(",");
1272 if (tokens.length < 2) {
1273 throw new IncompatibleDataException(
1274 MessageKeyEnum.IDT_000001.toString());
1277 if ("".equals(axis1Name)) {
1278 axis1Name = tokens[0];
1279 } else if (!axis1Name.equals(tokens[0])) {
1280 LOG.debug("Axis must be the same for all documents");
1281 throw new IncompatibleDataException(
1282 MessageKeyEnum.IDT_000001.toString());
1285 if ("".equals(axis2Name)) {
1286 axis2Name = tokens[1];
1287 } else if (!axis2Name.equals(tokens[1])) {
1288 LOG.debug("Axis must be the same for all documents");
1289 throw new IncompatibleDataException(
1290 MessageKeyEnum.IDT_000001.toString());
1294 // Get the XY points series.
1295 while (input.hasNext()) {
1297 String currentString = input.nextLine();
1299 if (!("".equals(currentString))) {
1300 String[] tokens = currentString.split(" ");
1301 series.add(Double.valueOf(tokens[0]), Double
1302 .valueOf(tokens[1]));
1307 dataset.addSeries(series);
1309 } catch (FileNotFoundException e) {
1310 LOG.error("Sorry, the file is not found.", e);
1314 JFreeChart chart = ChartFactory.createXYLineChart(chartTitle, // Title
1315 axis1Name, // x-axis Label
1316 axis2Name, // y-axis Label
1318 PlotOrientation.VERTICAL, // Plot Orientation
1319 true, // Show Legend
1320 true, // Use tooltips
1321 false // Configure chart to generate URLs?
1324 // export to PDF - file.
1327 Rectangle pagesize = new Rectangle(x, y);
1328 Document document = new Document(pagesize, 50, 50, 50, 50);
1331 File resFile = new File(resultPath);
1332 File resFolder = new File(resultPath.substring(0, resultPath
1333 .lastIndexOf(File.separator)));
1335 writer = PdfWriter.getInstance(document, new FileOutputStream(
1339 PdfContentByte cb = writer.getDirectContent();
1340 PdfTemplate tp = cb.createTemplate(x, y);
1341 Graphics2D g2 = tp.createGraphics(x, y, new DefaultFontMapper());
1342 chart.draw(g2, new java.awt.Rectangle(x, y));
1344 cb.addTemplate(tp, 0, 0);
1347 } catch (FileNotFoundException e) {
1348 LOG.error("Sorry, the file is not found.", e);
1349 } catch (DocumentException e) {
1350 LOG.error("Sorry, the DocumentException is thrown.", e);
1358 * @see org.splat.service.StudyService#getReaders(long)
1360 @Transactional(readOnly = true)
1361 public List<UserDTO> getReaders(final long studyId) throws InvalidParameterException {
1362 Study aStudy = selectStudy(studyId);
1364 throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
1366 List<Relation> relations = aStudy.getRelations(ReaderRelation.class);
1367 List<UserDTO> result = new ArrayList<UserDTO>();
1368 for(Relation relation : relations){
1369 result.add(BeanHelper.copyBean(relation.getTo(), UserDTO.class));
1371 return Collections.unmodifiableList(result);
1376 * @see org.splat.service.StudyService#addReader(long, long)
1379 public boolean addReader(final long studyId, final long userId) throws InvalidParameterException {
1380 Study aStudy = selectStudy(studyId);
1382 throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
1384 User user = _userService.selectUser(userId);
1386 throw new InvalidParameterException("userId", String.valueOf(userId));
1389 for(Relation relation : aStudy.getRelations(ReaderRelation.class)) {
1390 if(user.equals(relation.getTo())) {
1394 aStudy.addRelation(new ReaderRelation(aStudy, user));
1401 * @see org.splat.service.StudyService#removeReader(long, long)
1404 public boolean removeReader(final long studyId, final long userId) throws InvalidParameterException {
1405 Study aStudy = selectStudy(studyId);
1407 throw new InvalidParameterException(PARAM_STUDY_ID, String.valueOf(studyId));
1409 User user = _userService.selectUser(userId);
1411 throw new InvalidParameterException("userId", String.valueOf(userId));
1414 Relation relation = aStudy.removeRelation(ReaderRelation.class, user);
1416 return relation != null;
1420 * Get project settings.
1422 * @return Project settings service
1424 private ProjectSettingsService getProjectSettings() {
1425 return _projectSettings;
1429 * Set project settings service.
1431 * @param projectSettingsService
1432 * project settings service
1434 public void setProjectSettings(
1435 final ProjectSettingsService projectSettingsService) {
1436 _projectSettings = projectSettingsService;
1440 * Get the projectElementService.
1442 * @return the projectElementService
1444 public ProjectElementService getProjectElementService() {
1445 return _projectElementService;
1449 * Set the projectElementService.
1451 * @param projectElementService
1452 * the projectElementService to set
1454 public void setProjectElementService(
1455 final ProjectElementService projectElementService) {
1456 _projectElementService = projectElementService;
1460 * Get the stepService.
1462 * @return the stepService
1464 public StepService getStepService() {
1465 return _stepService;
1469 * Set the stepService.
1471 * @param stepService
1472 * the stepService to set
1474 public void setStepService(final StepService stepService) {
1475 _stepService = stepService;
1479 * Get the indexService.
1481 * @return the indexService
1483 public IndexService getIndexService() {
1484 return _indexService;
1488 * Set the indexService.
1490 * @param indexService
1491 * the indexService to set
1493 public void setIndexService(final IndexService indexService) {
1494 _indexService = indexService;
1500 * @return the studyDAO
1502 public StudyDAO getStudyDAO() {
1510 * the studyDAO to set
1512 public void setStudyDAO(final StudyDAO studyDAO) {
1513 _studyDAO = studyDAO;
1517 * Get the iDBuilderDAO.
1519 * @return the iDBuilderDAO
1521 public IDBuilderDAO getIDBuilderDAO() {
1522 return _iDBuilderDAO;
1526 * Set the iDBuilderDAO.
1529 * the iDBuilderDAO to set
1531 public void setIDBuilderDAO(final IDBuilderDAO builderDAO) {
1532 _iDBuilderDAO = builderDAO;
1536 * Get the scenarioDAO.
1538 * @return the scenarioDAO
1540 public ScenarioDAO getScenarioDAO() {
1541 return _scenarioDAO;
1545 * Set the scenarioDAO.
1547 * @param scenarioDAO
1548 * the scenarioDAO to set
1550 public void setScenarioDAO(final ScenarioDAO scenarioDAO) {
1551 _scenarioDAO = scenarioDAO;
1555 * Get the validationCycleDAO.
1557 * @return the validationCycleDAO
1559 public ValidationCycleDAO getValidationCycleDAO() {
1560 return _validationCycleDAO;
1564 * Set the validationCycleDAO.
1566 * @param validationCycleDAO
1567 * the validationCycleDAO to set
1569 public void setValidationCycleDAO(
1570 final ValidationCycleDAO validationCycleDAO) {
1571 _validationCycleDAO = validationCycleDAO;
1575 * Get the documentTypeService.
1577 * @return the documentTypeService
1579 public DocumentTypeService getDocumentTypeService() {
1580 return _documentTypeService;
1584 * Set the documentTypeService.
1586 * @param documentTypeService
1587 * the documentTypeService to set
1589 public void setDocumentTypeService(
1590 final DocumentTypeService documentTypeService) {
1591 _documentTypeService = documentTypeService;
1595 * Get the userService.
1597 * @return the userService
1599 public UserService getUserService() {
1600 return _userService;
1604 * Set the userService.
1606 * @param userService
1607 * the userService to set
1609 public void setUserService(final UserService userService) {
1610 _userService = userService;
1616 * @see org.splat.service.StudyService#getComparableStudies()
1618 @Transactional(readOnly = true)
1619 public List<StudyFacadeDTO> getComparableStudies(final long userId)
1620 throws MismatchException {
1621 // retrieve the number of the "Analyze the results" step
1622 List<Step> allSteps = _projectSettings.getAllSteps();
1623 Step theAnalyzeStep = null;
1624 for (Step step : allSteps) {
1625 if (step.getKey().equals("postprocessing")) {
1626 theAnalyzeStep = step;
1629 if (theAnalyzeStep == null) { // TODO: throw some other exception
1630 throw new MismatchException(
1631 "no step with key 'postprocessing' found."
1632 + "Probably, customization settings have been changed.");
1635 List<Publication> publications = _publicationDAO.getFilteredList(
1636 "mydoc", Restrictions.eq("step", Integer.valueOf(theAnalyzeStep
1639 // split retrieved publications into groups by studies and scenarios
1640 Map<Study, List<ProjectElement>> studyMap = new HashMap<Study, List<ProjectElement>>();
1641 Map<ProjectElement, List<Publication>> scenarioMap = new HashMap<ProjectElement, List<Publication>>();
1643 for (Publication publication : publications) {
1644 // filter out publications corresponding to a document of given step which is not a _result_ document
1645 if (!publication.value().getType().isResultOf(theAnalyzeStep)
1646 || !"srd".equals(publication.getSourceFile().getFormat())) {
1650 // check the study visibility to the user
1651 if (!isStaffedBy(publication.getOwnerStudy(), _userService
1652 .selectUser(userId))
1653 && Visibility.PUBLIC.equals(publication.getOwnerStudy()
1654 .getVisibility())) {
1658 Study study = publication.getOwnerStudy();
1659 ProjectElement scenario = publication.getOwner();
1661 Hibernate.initialize(scenario);
1662 if (scenario instanceof HibernateProxy) {
1663 scenario = (ProjectElement) ((HibernateProxy) scenario)
1664 .getHibernateLazyInitializer().getImplementation();
1667 if (!(scenario instanceof Scenario)) {
1668 throw new MismatchException(
1669 "publications from postprocessing step are supposed to have owner scenario");
1672 if (!studyMap.containsKey(study)) {
1673 studyMap.put(study, new ArrayList<ProjectElement>());
1676 if (!studyMap.get(study).contains(scenario)) {
1677 studyMap.get(study).add(scenario);
1680 if (!scenarioMap.containsKey(scenario)) {
1681 scenarioMap.put(scenario, new ArrayList<Publication>());
1683 scenarioMap.get(scenario).add(publication);
1686 // Create the result DTOs
1687 List<StudyFacadeDTO> result = new ArrayList<StudyFacadeDTO>();
1688 for (Study study : studyMap.keySet()) {
1690 StudyFacadeDTO studyDTO = new StudyFacadeDTO();
1691 studyDTO.setName(study.getTitle());
1692 studyDTO.setScenarios(new ArrayList<StudyFacadeDTO.ScenarioDTO>());
1693 result.add(studyDTO);
1695 for (ProjectElement scenario : studyMap.get(study)) {
1697 StudyFacadeDTO.ScenarioDTO scenarioDTO = new StudyFacadeDTO.ScenarioDTO();
1698 scenarioDTO.setName(scenario.getTitle());
1699 scenarioDTO.setDocs(new ArrayList<DocumentDTO>());
1700 studyDTO.getScenarios().add(scenarioDTO);
1702 for (Publication publication : scenarioMap.get(scenario)) {
1704 DocumentDTO documentDTO = new DocumentDTO();
1705 documentDTO.setId(publication.getIndex());
1706 documentDTO.setTitle(publication.value().getTitle());
1708 scenarioDTO.getDocs().add(documentDTO);
1716 * Get the publicationDAO.
1718 * @return the publicationDAO
1720 public PublicationDAO getPublicationDAO() {
1721 return _publicationDAO;
1725 * Set the publicationDAO.
1727 * @param publicationDAO
1728 * the publicationDAO to set
1730 public void setPublicationDAO(final PublicationDAO publicationDAO) {
1731 _publicationDAO = publicationDAO;
1735 * Get the repositoryService.
1737 * @return the repositoryService
1739 public RepositoryService getRepositoryService() {
1740 return _repositoryService;
1744 * Set the repositoryService.
1746 * @param repositoryService
1747 * the repositoryService to set
1749 public void setRepositoryService(final RepositoryService repositoryService) {
1750 _repositoryService = repositoryService;
1754 * Get the documentDAO.
1756 * @return the documentDAO
1758 public DocumentDAO getDocumentDAO() {
1759 return _documentDAO;
1763 * Set the documentDAO.
1765 * @param documentDAO
1766 * the documentDAO to set
1768 public void setDocumentDAO(final DocumentDAO documentDAO) {
1769 _documentDAO = documentDAO;
1773 * Get the descriptionAttributeDAO.
1775 * @return the descriptionAttributeDAO
1777 public DescriptionAttributeDAO getDescriptionAttributeDAO() {
1778 return _descriptionAttributeDAO;
1782 * Set the descriptionAttributeDAO.
1784 * @param descriptionAttributeDAO
1785 * the descriptionAttributeDAO to set
1787 public void setDescriptionAttributeDAO(
1788 final DescriptionAttributeDAO descriptionAttributeDAO) {
1789 _descriptionAttributeDAO = descriptionAttributeDAO;
1793 * Get the usedByRelationDAO.
1795 * @return the usedByRelationDAO
1797 public UsedByRelationDAO getUsedByRelationDAO() {
1798 return _usedByRelationDAO;
1802 * Set the usedByRelationDAO.
1804 * @param usedByRelationDAO
1805 * the usedByRelationDAO to set
1807 public void setUsedByRelationDAO(final UsedByRelationDAO usedByRelationDAO) {
1808 _usedByRelationDAO = usedByRelationDAO;