Workspace/Siman-Common/src/org/splat/service/StudyServiceImpl.java

   1 /*****************************************************************************
   2  * Company         OPEN CASCADE
   3  * Application     SIMAN
   4  * File            Id:
   5  * Creation date   02.10.2012
   6  * @author         Author: Maria KRUCHININA
   7  * @version        Revision:
   8  *****************************************************************************/
   9
  10 package org.splat.service;
  11
  12 import java.awt.Graphics2D;
  13 import java.io.File;
  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;
  27 import java.util.Map;
  28 import java.util.Scanner;
  29 import java.util.Set;
  30
  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;
  92
  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;
 100
 101 /**
 102  * This class defines all methods for creation, modification the study.
 103  *
 104  * @author Maria KRUCHININA
 105  *
 106  */
 107 public class StudyServiceImpl implements StudyService {
 108
 109         /**
 110          * logger for the service.
 111          */
 112         public final static AppLogger LOG = AppLogger
 113                         .getLogger(StudyServiceImpl.class);
 114         /**
 115          * "studyId" parameter name.
 116          */
 117         public final static String PARAM_STUDY_ID = "studyId";
 118
 119         /**
 120          * Injected index service.
 121          */
 122         private IndexService _indexService;
 123
 124         /**
 125          * Injected step service.
 126          */
 127         private StepService _stepService;
 128
 129         /**
 130          * Injected project service.
 131          */
 132         private ProjectSettingsService _projectSettings;
 133
 134         /**
 135          * Injected project element service.
 136          */
 137         private ProjectElementService _projectElementService;
 138
 139         /**
 140          * Injected study DAO.
 141          */
 142         private StudyDAO _studyDAO;
 143
 144         /**
 145          * Injected usedBy relations DAO.
 146          */
 147         private UsedByRelationDAO _usedByRelationDAO;
 148
 149         /**
 150          * Injected scenario DAO.
 151          */
 152         private ScenarioDAO _scenarioDAO;
 153
 154         /**
 155          * Injected validation cycle DAO.
 156          */
 157         private ValidationCycleDAO _validationCycleDAO;
 158
 159         /**
 160          * Injected IDBuilder DAO.
 161          */
 162         private IDBuilderDAO _iDBuilderDAO;
 163
 164         /**
 165          * Injected document type service.
 166          */
 167         private DocumentTypeService _documentTypeService;
 168
 169         /**
 170          * Injected user service.
 171          */
 172         private UserService _userService;
 173
 174         /**
 175          * Injected publication DAO.
 176          */
 177         private PublicationDAO _publicationDAO;
 178
 179         /**
 180          * Injected repository service.
 181          */
 182         private RepositoryService _repositoryService;
 183
 184         /**
 185          * Injected document DAO.
 186          */
 187         private DocumentDAO _documentDAO;
 188
 189         /**
 190          * Injected description attribute DAO.
 191          */
 192         private DescriptionAttributeDAO _descriptionAttributeDAO;
 193
 194         /**
 195          * {@inheritDoc}
 196          *
 197          * @see org.splat.service.StudyService#selectStudy(long)
 198          */
 199         @Transactional
 200         public Study selectStudy(final long index) {
 201                 Study result = getStudyDAO().get(index);
 202                 if (result != null) {
 203                         loadWorkflow(result);
 204                 }
 205                 return result;
 206         }
 207
 208         /**
 209          * {@inheritDoc}
 210          *
 211          * @see org.splat.service.StudyService#removeStudy(long)
 212          */
 213         @Transactional
 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>();
 217                 if (study != null) {
 218                         // Select all documents published in the study and study's scenarios.
 219                         DetachedCriteria query = DetachedCriteria.forClass(
 220                                         Publication.class, "pub");
 221                         query
 222                                         .createCriteria("pub.owner", "projelem",
 223                                                         Criteria.INNER_JOIN)
 224                                         .createAlias("projelem.owner", "study", Criteria.LEFT_JOIN)
 225                                         .add(
 226                                                         Restrictions
 227                                                                         .or(Restrictions.eq("projelem.rid", index),
 228                                                                                         Restrictions.eq("study.rid", index)))
 229                                         .setResultTransformer(Criteria.DISTINCT_ROOT_ENTITY);
 230
 231                         if (LOG.isDebugEnabled()) {
 232                                 LOG.debug("Find study documents: " + query.toString());
 233                         }
 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()) {
 240                                         docums.add(prev);
 241                                 }
 242                         }
 243
 244                         // Delete the study with its relations, scenarios and publications
 245                         getStudyDAO().delete(study);
 246
 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();
 252                         }
 253                         getDocumentDAO().flush();
 254
 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);
 260                         }
 261                 }
 262         }
 263
 264         /**
 265          * Get study by its reference.
 266          *
 267          * @param refid
 268          *            the study reference
 269          * @return found study or null
 270          */
 271         @Transactional(readOnly = true)
 272         public Study selectStudy(final String refid) {
 273                 Study result = getStudyDAO().findByCriteria(
 274                                 Restrictions.eq("sid", refid));
 275                 loadWorkflow(result);
 276                 return result;
 277         }
 278
 279         /**
 280          * {@inheritDoc}
 281          *
 282          * @see org.splat.service.StudyService#createStudy(org.splat.dal.bo.som.Study.Properties)
 283          */
 284         @Transactional
 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);
 290
 291                 buildReference(study);
 292                 getStudyDAO().create(study);
 293                 // try {
 294                 // IndexService lucin = getIndex();
 295                 // lucin.add(study);
 296                 // } catch (IOException error) {
 297                 // LOG.error("Unable to index the study '" + study.getIndex()
 298                 // + "', reason:", error);
 299                 // // Continue and try to index later
 300                 // }
 301                 return study;
 302         }
 303
 304         /**
 305          * {@inheritDoc}
 306          *
 307          * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext.Properties)
 308          */
 309         @Transactional
 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);
 316                 update(aStudy);
 317                 return added;
 318         }
 319
 320         /**
 321          * {@inheritDoc}
 322          *
 323          * @see org.splat.service.StudyService#addProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
 324          */
 325         @Transactional
 326         public SimulationContext addProjectContext(final Study aStudy,
 327                         final SimulationContext context) {
 328                 SimulationContext added = getStepService().addSimulationContext(
 329                                 getProjectElementService().getFirstStep(aStudy), context);
 330                 update(aStudy);
 331                 return added;
 332         }
 333
 334         /**
 335          * {@inheritDoc}
 336          *
 337          * @see org.splat.service.StudyService#addContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User)
 338          */
 339         @Transactional
 340         public boolean addContributor(final Study aStudy, final User user) {
 341                 List<User> contributors = getModifiableContributors(aStudy); // Initializes contributor
 342
 343                 if(contributors.contains(user)) {
 344                         return false;
 345                 }
 346
 347                 //Remove user from readers
 348                 try {
 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);
 354                                 }
 355                         }
 356                 } catch(InvalidParameterException e) {
 357                         LOG.error(e.getMessage(), e);
 358                 }
 359
 360                 boolean absent = getModifiableActors(aStudy).add(user); // User may already be a reviewer or an approver
 361
 362                 aStudy.addRelation(new ContributorRelation(aStudy, user));
 363                 if (absent) {
 364                         update(aStudy); // Else, useless to re-index the study
 365                 }
 366                 return true;
 367         }
 368
 369         /**
 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.
 372          *
 373          * @param aStudy
 374          *            the study to move
 375          * @return true if the move succeeded.
 376          * @see #moveToPublic()
 377          * @see #isPublic()
 378          * @see Publication#approve(Date)
 379          */
 380         @Transactional
 381         public boolean moveToReference(final Study aStudy) {
 382                 if (aStudy.getProgressState() != ProgressState.APPROVED) {
 383                         return false;
 384                 }
 385                 if (aStudy.getVisibility() != Visibility.PUBLIC) {
 386                         return false;
 387                 }
 388
 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
 392                 }
 393                 return false;
 394         }
 395
 396         /**
 397          * {@inheritDoc}
 398          *
 399          * @see org.splat.service.StudyService#update(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.Study.Properties)
 400          */
 401         @Transactional
 402         public boolean update(final Study aStudy, final Properties sprop)
 403                         throws InvalidPropertyException {
 404                 if (sprop.getTitle() != null) {
 405                         aStudy.setTitle(sprop.getTitle());
 406                 }
 407                 if (sprop.getSummary() != null) {
 408                         aStudy.setAttribute(new DescriptionAttribute(aStudy, sprop
 409                                         .getSummary()));
 410                 }
 411                 // TODO: To be completed
 412                 return update(aStudy);
 413         }
 414
 415         /**
 416          * Check if the document is published in the study.
 417          *
 418          * @param aStudy
 419          *            the study
 420          * @param doc
 421          *            the document
 422          * @return true if the document is published in the study
 423          */
 424         /*
 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; }
 427          */
 428         /**
 429          * {@inheritDoc}
 430          *
 431          * @see org.splat.service.StudyService#removeContributor(org.splat.dal.bo.som.Study, org.splat.dal.bo.kernel.User[])
 432          */
 433         @Transactional
 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);
 441                                 done = true;
 442                         }
 443                 }
 444                 if (done) {
 445                         update(aStudy);
 446                 }
 447                 return done;
 448         }
 449
 450         /**
 451          * {@inheritDoc}
 452          *
 453          * @see org.splat.service.StudyService#removeProjectContext(org.splat.dal.bo.som.Study, org.splat.dal.bo.som.SimulationContext)
 454          */
 455         @Transactional
 456         public boolean removeProjectContext(final Study aStudy,
 457                         final SimulationContext context) {
 458                 boolean done = getStepService().removeSimulationContext(
 459                                 getProjectElementService().getFirstStep(aStudy), context);
 460                 update(aStudy);
 461                 return done;
 462         }
 463
 464         /**
 465          * {@inheritDoc}
 466          *
 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)
 469          */
 470         @Transactional
 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
 477                 }
 478
 479                 Study aStudy = selectStudy(aStudyDTO.getIndex());
 480
 481                 String cname = type.getName();
 482                 ValidationCycle cycle = validactor.get(cname);
 483
 484                 if (cycle != null && cycle.isAssigned()) {
 485                         resetActors(cycle, vprop);
 486                 } else {
 487                         try {
 488                                 cycle = new ValidationCycle(aStudy, vprop.setDocumentType(type));
 489
 490                                 getValidationCycleDAO().create(cycle); // RKV
 491
 492                                 ValidationCycleRelation link = cycle.getContext();
 493                                 aStudy.addRelation(link);
 494                                 aStudyDTO.getAllRelations().add(link); // RKV
 495
 496                                 validactor.put(cname, link.getTo()); // Replaces the cycle if exists as default,
 497                         } catch (BusinessException error) {
 498                                 LOG.error("Unable to create validation cycle, reason:", error);
 499                                 return;
 500                         }
 501                 }
 502                 resetActorsShortCut(aStudyDTO);
 503                 update(aStudy); // Re-index the study, just in case
 504         }
 505
 506         /**
 507          * Demotes this study from In-Check to In-Draft then In-Work states. This function is called internally when demoting the final result
 508          * document of the study.
 509          *
 510          * @param aStudy
 511          *            a study to demote
 512          * @return true if the demotion succeeded.
 513          */
 514         @Transactional
 515         public boolean demote(final Study aStudy) {
 516                 if (aStudy.getProgressState() == ProgressState.inCHECK) {
 517                         aStudy.setProgressState(ProgressState.inDRAFT);
 518                 } else if (aStudy.getProgressState() == ProgressState.inDRAFT) {
 519                         aStudy.setProgressState(ProgressState.inWORK);
 520                 } else {
 521                         return false;
 522                 }
 523                 return update(aStudy);
 524         }
 525
 526         /**
 527          * {@inheritDoc}
 528          *
 529          * @see org.splat.service.StudyService#generateLocalIndex(org.splat.dal.bo.som.Study)
 530          */
 531         @Transactional
 532         public int generateLocalIndex(final Study aStudy) {
 533                 aStudy.setLastLocalIndex(aStudy.getLastLocalIndex() + 1);
 534                 return aStudy.getLastLocalIndex();
 535         }
 536
 537         /**
 538          * Promotes this study from In-Work to In-Draft then In-Check and APPROVED states. This function is called internally when promoting the
 539          * final result document of the study.
 540          *
 541          * @param aStudy
 542          *            a study to promote
 543          * @return true if the demotion succeeded.
 544          */
 545         @Transactional
 546         public boolean promote(final Study aStudy) {
 547                 if (aStudy.getProgressState() == ProgressState.inWORK) {
 548                         aStudy.setProgressState(ProgressState.inDRAFT);
 549                 } else if (aStudy.getProgressState() == ProgressState.inDRAFT) {
 550                         aStudy.setProgressState(ProgressState.inCHECK);
 551                         Revision myvers = new Revision(aStudy.getVersion());
 552                         if (myvers.isMinor()) {
 553                                 aStudy.setVersion(myvers.incrementAs(aStudy.getProgressState())
 554                                                 .toString());
 555                         }
 556                 } else if (aStudy.getProgressState() == ProgressState.inCHECK) {
 557                         aStudy.setProgressState(ProgressState.APPROVED);
 558                 } else {
 559                         return false;
 560                 }
 561
 562                 return update(aStudy);
 563         }
 564
 565         /**
 566          * Moves this study from the Private to the Public area of the repository.
 567          *
 568          * @param aStudy
 569          *            a study to move
 570          * @return true if the move succeeded.
 571          * @see #isPublic()
 572          */
 573         @Transactional
 574         public boolean moveToPublic(final Study aStudy) {
 575                 boolean isOk = false;
 576                 if (aStudy.getVisibility() == Visibility.PRIVATE) {
 577                         aStudy.setVisibility(Visibility.PUBLIC);
 578                         if (update(aStudy)) {
 579                                 isOk = updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
 580                         }
 581                 }
 582                 return isOk;
 583         }
 584
 585         /**
 586          * Moves this study from the Public to the Private area of the repository.
 587          *
 588          * @param aStudy
 589          *            a study to move
 590          * @return true if the move succeeded.
 591          */
 592         @Transactional
 593         public boolean moveToPrivate(final Study aStudy) {
 594                 boolean isOk = false;
 595                 if (aStudy.getVisibility() == Visibility.PUBLIC) {
 596                         aStudy.setVisibility(Visibility.PRIVATE);
 597                         if (update(aStudy)) {
 598                                 isOk = updateKnowledgeElementsIndex(aStudy); // If fails, the database roll-back is under responsibility of the caller
 599                         }
 600                 }
 601                 return isOk;
 602         }
 603
 604         /**
 605          * Update a study in the database.
 606          *
 607          * @param aStudy
 608          *            the study to update
 609          * @return true if the study is updated successfully
 610          */
 611         private boolean update(final Study aStudy) {
 612                 boolean isOk = false;
 613                 try {
 614                         getStudyDAO().merge(aStudy); // Update of relational base
 615                         setShortCuts(aStudy); // RKV: initialize transient actors set
 616                         //RKV: getIndex().update(aStudy); // Update of Lucene index
 617                         isOk = true;
 618                 } catch (Exception e) {
 619                         LOG.error("STD-000001", e, aStudy.getIndex(), e.getMessage());
 620                 }
 621                 return isOk;
 622         }
 623
 624         /**
 625          * Build reference for the study. The reference of the study is stored as a new reference pattern (IDBuilder).
 626          *
 627          * @param aStudy
 628          *            the study
 629          * @return true if reference building is succeded
 630          */
 631         @Transactional
 632         private boolean buildReference(final Study aStudy) {
 633                 String pattern = aStudy.getReference(); // The study being supposed just created, its reference is the reference pattern
 634                 IDBuilder tool = selectIDBuilder(aStudy.getDate());
 635                 if (tool == null) {
 636                         tool = new IDBuilder(aStudy.getDate());
 637                         getIDBuilderDAO().create(tool);
 638                 }
 639                 aStudy.setReference(buildReference(tool, pattern, aStudy));
 640                 return true;
 641         }
 642
 643         /**
 644          * Build reference for the study. The reference of the study is stored as a new reference pattern (IDBuilder).
 645          *
 646          * @param aBuilder
 647          *            the id builder
 648          * @param study
 649          *            the study
 650          * @param pattern
 651          *            the reference pattern
 652          * @return true if reference building is succeded
 653          */
 654         @Transactional
 655         public String buildReference(final IDBuilder aBuilder,
 656                         final String pattern, final Study study) {
 657                 char[] format = pattern.toCharArray();
 658                 char[] ref = new char[80]; // Better evaluate the length of the generated string
 659                 int next = aBuilder.getBase() + 1;
 660
 661                 int count = 0;
 662                 for (int i = 0; i < format.length; i++) {
 663
 664                         // Insertion of attribute values
 665                         if (format[i] == '%') {
 666                                 i += 1;
 667
 668                                 if (format[i] == 'y') { // Insertion of year in format 2 (e.g. 09) or 4 (e.g. 2009) digits
 669                                         int n = i;
 670                                         while (format[i] == 'y') {
 671                                                 i += 1;
 672                                                 if (i == format.length) {
 673                                                         break;
 674                                                 }
 675                                         }
 676                                         SimpleDateFormat tostring = new SimpleDateFormat("yyyy"); // RKV: NOPMD: TODO: Use locale here?
 677                                         String year = tostring.format(study.getDate());
 678                                         year = year.substring(4 - (i - n), 4); // 4-(i-n) must be equal to either 0 or 2
 679                                         for (int j = 0; j < year.length(); j++) {
 680                                                 ref[count] = year.charAt(j);
 681                                                 count += 1;
 682                                         }
 683                                         i -= 1; // Back to the last 'y' character
 684                                 } else if (format[i] == '0') { // Insertion of the index
 685                                         int n = i;
 686                                         while (format[i] == '0') {
 687                                                 i += 1;
 688                                                 if (i == format.length) {
 689                                                         break;
 690                                                 }
 691                                         }
 692                                         DecimalFormat tostring = new DecimalFormat(pattern
 693                                                         .substring(n, i));
 694                                         String number = tostring.format(next);
 695                                         for (int j = 0; j < number.length(); j++) {
 696                                                 ref[count] = number.charAt(j);
 697                                                 count += 1;
 698                                         }
 699                                         i -= 1; // Back to the last '0' character
 700                                 }
 701                                 // Keep the character
 702                         } else {
 703                                 ref[count] = format[i];
 704                                 count += 1;
 705                         }
 706                 }
 707                 // Incrementation of the number of study
 708                 aBuilder.setBase(next);
 709                 getIDBuilderDAO().update(aBuilder);
 710                 return String.copyValueOf(ref, 0, count);
 711         }
 712
 713         /**
 714          * Find an id builder by date.
 715          *
 716          * @param date
 717          *            the date
 718          * @return found id builder
 719          */
 720         private IDBuilder selectIDBuilder(final Date date) {
 721                 Calendar aDate = Calendar.getInstance();
 722                 aDate.setTime(date);
 723                 return getIDBuilderDAO().findByCriteria(
 724                                 Restrictions.eq("cycle", aDate.get(Calendar.YEAR)));
 725         }
 726
 727         /**
 728          * Fill transient collection ModifiableActors of the study.
 729          *
 730          * @param aStudy
 731          *            the study
 732          */
 733         private void resetActorsShortCut(final Study aStudy) {
 734                 getModifiableActors(aStudy).clear();
 735                 // Get all actors involved in validation cycles
 736                 for (Iterator<ValidationCycle> i = aStudy.getValidationCycles()
 737                                 .values().iterator(); i.hasNext();) {
 738                         ValidationCycle cycle = i.next();
 739                         User[] user = cycle.getAllActors();
 740                         for (int j = 0; j < user.length; j++) {
 741                                 getModifiableActors(aStudy).add(user[j]);
 742                         }
 743                 }
 744                 // Get all other actors
 745                 for (Iterator<Relation> i = aStudy.getAllRelations().iterator(); i
 746                                 .hasNext();) {
 747                         Relation link = i.next();
 748                         Class<?> kindof = link.getClass().getSuperclass();
 749                         if (!kindof.equals(ActorRelation.class)) {
 750                                 continue;
 751                         }
 752                         getModifiableActors(aStudy).add(((ActorRelation) link).getTo());
 753                 }
 754         }
 755
 756         /**
 757          * Update lucene index for the study knowledge elements.
 758          *
 759          * @param aStudy
 760          *            the study
 761          * @return true if reindexing succeeded
 762          */
 763         private boolean updateKnowledgeElementsIndex(final Study aStudy) {
 764 //              boolean isOk = false;
 765 //               try {
 766 //                       IndexService lucin = getIndex();
 767 //                       for(Scenario scenario : aStudy.getScenariiList()) {
 768 //                               for (KnowledgeElement element : scenario.getAllKnowledgeElements()) {
 769 //                                       lucin.update(element);
 770 //                               }
 771 //                       }
 772 //                       isOk = true;
 773 //               } catch (Exception error) {
 774 //                       LOG.error("Unable to re-index Knowledge Elements, reason:",
 775 //                       error);
 776 //               }
 777 //               return isOk;
 778                 return true;
 779         }
 780
 781         /**
 782          * Get lucene index service. Create a lucene index if it does not exist.
 783          *
 784          * @return index service
 785          * @throws IOException
 786          *             if error occurs during lucene index creation
 787          */
 788         private IndexService getIndex() throws IOException {
 789                 IndexService lucin = getIndexService();
 790                 if (IndexWriter.isLocked(FSDirectory.open(getRepositoryService()
 791                                 .getRepositoryIndexDirectory()))) {
 792                         IndexWriter.unlock(FSDirectory.open(getRepositoryService()
 793                                         .getRepositoryIndexDirectory()));
 794                 }
 795                 if (!lucin.exists()) {
 796                         lucin.create(); // Happens when re-indexing all studies
 797                 }
 798                 return lucin;
 799         }
 800
 801         /**
 802          * Create a new validation cycle for documents of the given study.
 803          *
 804          * @param from
 805          *            the study
 806          * @param cycle
 807          *            the cycle description
 808          * @return the new validation cycle
 809          */
 810         protected ValidationCycle createValidationCycle(
 811                         final Study from,
 812                         final ProjectSettingsServiceImpl.ProjectSettingsValidationCycle cycle) {
 813                 Actor[] actype = cycle.getActorTypes();
 814                 User.Properties uprop = new User.Properties();
 815
 816                 ValidationCycle aValidationCycle = new ValidationCycle();
 817                 aValidationCycle.setDocumentType(getDocumentTypeService().selectType(
 818                                 cycle.getName())); // Null in case of default validation cycle
 819                 // context = new ValidationCycleRelation(from, vprop);
 820                 // RKV aValidationCycle.context = null; // Validation cycle defined in the workflow
 821                 for (int i = 0; i < actype.length; i++) {
 822                         User actor = null;
 823                         if (actype[i] != null) {
 824                                 try {
 825                                         if (actype[i] == Actor.manager) {
 826                                                 actor = from.getAuthor();
 827                                         } else if (actype[i] == Actor.Nx1) {
 828                                                 List<User> manager = getUserService().selectUsersWhere(
 829                                                                 uprop.setOrganizationName("Nx1"));
 830                                                 if (manager.size() == 1) {
 831                                                         actor = manager.get(0);
 832                                                 }
 833                                         } else if (actype[i] == Actor.Nx2) {
 834                                                 List<User> manager = getUserService().selectUsersWhere(
 835                                                                 uprop.setOrganizationName("Nx2"));
 836                                                 if (manager.size() == 1) {
 837                                                         actor = manager.get(0);
 838                                                 }
 839                                         } else { /* Actor.customer */
 840                                                 actor = from.getAuthor();
 841                                                 // TODO: Get the customer of the study, if exists
 842                                         }
 843                                 } catch (Exception e) { // Should not happen
 844                                         actor = null;
 845                                 }
 846                         }
 847                         if (i == 0) {
 848                                 aValidationCycle.setReviewer(actor);
 849                         } else if (i == 1) {
 850                                 aValidationCycle.setApprover(actor);
 851                         } else if (i == 2) {
 852                                 aValidationCycle.setSignatory(actor);
 853                         }
 854                 }
 855                 return aValidationCycle;
 856         }
 857
 858         /**
 859          * Remove a validation step from the validation cycle.
 860          *
 861          * @param aValidationCycle
 862          *            the validation cycle
 863          * @param step
 864          *            the validation step to remove
 865          */
 866         @Transactional
 867         protected void remove(final ValidationCycle aValidationCycle,
 868                         final ValidationStep step) {
 869                 if (step == ValidationStep.REVIEW) {
 870                         aValidationCycle.setReviewer(null);
 871                 } else if (step == ValidationStep.APPROVAL) {
 872                         aValidationCycle.setApprover(null);
 873                 } else if (step == ValidationStep.ACCEPTANCE
 874                                 || step == ValidationStep.REFUSAL) {
 875                         aValidationCycle.setSignatory(null);
 876                 }
 877                 if (aValidationCycle.isSaved()) {
 878                         getValidationCycleDAO().update(aValidationCycle);
 879                 }
 880         }
 881
 882         /**
 883          * Reset actors for the validation cycle.
 884          *
 885          * @param aValidationCycle
 886          *            the validation cycle to update
 887          * @param vprop
 888          *            new validation cycle properties containing new actors
 889          */
 890         @Transactional
 891         public void resetActors(final ValidationCycle aValidationCycle,
 892                         final ValidationCycle.Properties vprop) {
 893                 aValidationCycle.setPublisher(vprop.getPublisher()); // May be null
 894                 aValidationCycle.setReviewer(vprop.getReviewer()); // May be null
 895                 aValidationCycle.setApprover(vprop.getApprover()); // May be null
 896                 aValidationCycle.setSignatory(vprop.getSignatory()); // May be null
 897                 if (aValidationCycle.isSaved()) {
 898                         getValidationCycleDAO().merge(aValidationCycle);
 899                 }
 900         }
 901
 902         /**
 903          * Set actor for the given validation cycle and validation step.
 904          *
 905          * @param aValidationCycle
 906          *            the validation cycle
 907          * @param step
 908          *            the validation step
 909          * @param actor
 910          *            the actor to set
 911          */
 912         @Transactional
 913         protected void setActor(final ValidationCycle aValidationCycle,
 914                         final ValidationStep step, final User actor) {
 915                 if (step == ValidationStep.PROMOTION) {
 916                         aValidationCycle.setPublisher(actor);
 917                 } else if (step == ValidationStep.REVIEW) {
 918                         aValidationCycle.setReviewer(actor);
 919                 } else if (step == ValidationStep.APPROVAL) {
 920                         aValidationCycle.setApprover(actor);
 921                 } else if (step == ValidationStep.ACCEPTANCE
 922                                 || step == ValidationStep.REFUSAL) {
 923                         aValidationCycle.setSignatory(actor);
 924                 }
 925                 if (aValidationCycle.isSaved()) {
 926                         getValidationCycleDAO().update(aValidationCycle);
 927                 }
 928         }
 929
 930         /**
 931          * Returns all actors of this study other than the author, including contributors, reviewers and approvers.
 932          *
 933          * @param aStudy
 934          *            the study
 935          * @return the actors of this study
 936          * @see #hasActor(User)
 937          */
 938         public Set<User> getActors(final Study aStudy) {
 939                 if (aStudy.getActor() == null) {
 940                         setShortCuts(aStudy);
 941                 }
 942                 return Collections.unmodifiableSet(aStudy.getActor());
 943         }
 944
 945         /**
 946          * Returns all actors of this study other than the author, including contributors, reviewers and approvers.
 947          *
 948          * @param aStudy
 949          *            the study
 950          * @return the modifiable set of actors of this study
 951          * @see #hasActor(User)
 952          */
 953         public Set<User> getModifiableActors(final Study aStudy) {
 954                 if (aStudy.getActor() == null) {
 955                         setShortCuts(aStudy);
 956                 }
 957                 return aStudy.getActor();
 958         }
 959
 960         /**
 961          * Returns unmodifiable initialized transient list of contributors of this study.
 962          *
 963          * @param aStudy
 964          *            the study
 965          * @return the unmodifiable not null transient list of contributors of this study
 966          */
 967         public List<User> getContributors(final Study aStudy) {
 968                 if (aStudy.getContributor() == null) {
 969                         setShortCuts(aStudy);
 970                 }
 971                 return Collections.unmodifiableList(aStudy.getContributor()); // May be empty
 972         }
 973
 974         /**
 975          * Returns modifiable initialized transient list of contributors of this study.
 976          *
 977          * @param aStudy
 978          *            the study
 979          * @return the modifiable not null transient list of contributors of this study
 980          */
 981         public List<User> getModifiableContributors(final Study aStudy) {
 982                 if (aStudy.getContributor() == null) {
 983                         setShortCuts(aStudy);
 984                 }
 985                 return aStudy.getContributor(); // May be empty
 986         }
 987
 988         /**
 989          * Returns the validation cycle of the given document type.
 990          *
 991          * @param aStudy
 992          *            the study
 993          * @param type
 994          *            the document type being subject of validation
 995          * @return the validation cycle of the document, or null if not defined.
 996          */
 997         public ValidationCycle getValidationCycleOf(final Study aStudy,
 998                         final DocumentType type) {
 999                 if (aStudy.getValidationCycles() == null
1000                                 || aStudy.getValidationCycles().isEmpty()) {
1001                         setShortCuts(aStudy);
1002                 }
1003                 ValidationCycle result = aStudy.getValidationCycles().get(
1004                                 type.getName());
1005                 if (result == null) {
1006                         if (type.isStepResult()) {
1007                                 result = aStudy.getValidationCycles().get("default"); // "default" validation cycle defined in the configuration, if exist
1008                         }
1009                         if (result == null) {
1010                                 result = aStudy.getValidationCycles().get("built-in");
1011                         }
1012                 }
1013                 return result;
1014         }
1015
1016         /**
1017          * Checks if the given user is actor of this study. Actors include contributors, reviewers and approvers.
1018          *
1019          * @param aStudy
1020          *            the study
1021          * @param user
1022          *            the user to look for
1023          * @return true if the given user is actor of this study.
1024          * @see #getActors()
1025          */
1026         public boolean hasActor(final Study aStudy, final User user) {
1027                 if (user == null) {
1028                         return false;
1029                 }
1030                 for (Iterator<User> i = getActors(aStudy).iterator(); i.hasNext();) {
1031                         User involved = i.next();
1032                         if (involved.equals(user)) {
1033                                 return true;
1034                         }
1035                 }
1036                 return false;
1037         }
1038
1039         /**
1040          * Checks if the given user participates to this study. The Study staff includes the author and contributors.
1041          *
1042          * @param aStudy
1043          *            the study
1044          * @param user
1045          *            the user to look for
1046          * @return true if the given user is actor of this study.
1047          * @see #getContributors()
1048          */
1049         public boolean isStaffedBy(final Study aStudy, final User user) {
1050                 if (user == null) {
1051                         return false;
1052                 }
1053                 if (aStudy == null) {
1054                         return false;
1055                 }
1056                 if (aStudy.getAuthor() == null) {
1057                         return false;
1058                 }
1059                 if (aStudy.getAuthor().equals(user)) {
1060                         return true;
1061                 }
1062                 for (Iterator<User> i = getContributors(aStudy).iterator(); i.hasNext();) {
1063                         if (i.next().equals(user)) {
1064                                 return true;
1065                         }
1066                 }
1067                 return false;
1068         }
1069
1070         /**
1071          * Initialize shortcuts of the study as its transient collections.
1072          *
1073          * @param aStudy
1074          *            the study
1075          */
1076         public void loadWorkflow(final Study aStudy) {
1077                 setShortCuts(aStudy);
1078         }
1079
1080         /**
1081          * Initialize shortcuts of the study as its transient collections.
1082          *
1083          * @param aStudy
1084          *            the study
1085          */
1086         public void setShortCuts(final Study aStudy) {
1087                 aStudy.getContributor().clear();
1088                 aStudy.getValidationCycles().clear();
1089                 aStudy.getActor().clear();
1090
1091                 // Get the contributors
1092                 for (Iterator<Relation> i = aStudy.getRelations(
1093                                 ContributorRelation.class).iterator(); i.hasNext();) {
1094                         ContributorRelation link = (ContributorRelation) i.next();
1095                         aStudy.getContributor().add(link.getTo());
1096                 }
1097                 // Get the validation cycles specific to this study
1098                 for (Iterator<Relation> i = aStudy.getRelations(
1099                                 ValidationCycleRelation.class).iterator(); i.hasNext();) {
1100                         ValidationCycleRelation link = (ValidationCycleRelation) i.next();
1101                         aStudy.getValidationCycles().put(link.getDocumentType().getName(),
1102                                         link.getTo()); // The associated document type is necessarily not null in this
1103                         // context
1104                 }
1105                 // Get the validation cycles coming from the configured workflow and not overridden in this study
1106                 for (Iterator<ProjectSettingsServiceImpl.ProjectSettingsValidationCycle> i = getProjectSettings()
1107                                 .getAllValidationCycles().iterator(); i.hasNext();) {
1108                         ProjectSettingsServiceImpl.ProjectSettingsValidationCycle cycle = i
1109                                         .next();
1110                         String type = cycle.getName();
1111                         if (!aStudy.getValidationCycles().containsKey(type)) {
1112                                 aStudy.getValidationCycles().put(type,
1113                                                 createValidationCycle(aStudy, cycle));
1114                         }
1115                 }
1116                 // Get all corresponding actors
1117                 for (Iterator<ValidationCycle> i = aStudy.getValidationCycles()
1118                                 .values().iterator(); i.hasNext();) {
1119                         ValidationCycle cycle = i.next();
1120                         User[] user = cycle.getAllActors();
1121                         for (int j = 0; j < user.length; j++) {
1122                                 aStudy.getActor().add(user[j]);
1123                         }
1124                 }
1125                 // Get all other actors
1126                 for (Iterator<Relation> i = aStudy.getAllRelations().iterator(); i
1127                                 .hasNext();) {
1128                         Relation link = i.next();
1129                         Class<?> kindof = link.getClass().getSuperclass();
1130                         if (!kindof.equals(ActorRelation.class)) {
1131                                 continue;
1132                         }
1133                         aStudy.getActor().add(((ActorRelation) link).getTo());
1134                 }
1135         }
1136
1137         /**
1138          *
1139          * {@inheritDoc}
1140          *
1141          * @see org.splat.service.StudyService#markStudyAsReference(org.splat.dal.bo.som.Study)
1142          */
1143         @Transactional
1144         public void markStudyAsReference(final Study aStudy) {
1145
1146                 aStudy.setMarkreference(1);
1147                 aStudy.setProgressState(ProgressState.TEMPLATE);
1148                 getStudyDAO().merge(aStudy);
1149         }
1150
1151         /**
1152          *
1153          * {@inheritDoc}
1154          *
1155          * @see org.splat.service.StudyService#removeStudyAsReference(org.splat.dal.bo.som.Study)
1156          */
1157         @Transactional
1158         public void removeStudyAsReference(final Study aStudy) {
1159
1160                 aStudy.setMarkreference(0);
1161                 aStudy.setProgressState(ProgressState.APPROVED);
1162                 getStudyDAO().merge(aStudy);
1163         }
1164
1165         /**
1166          * {@inheritDoc}
1167          *
1168          * @see org.splat.service.StudyService#getDescription(java.lang.Long)
1169          */
1170         @Override
1171         @Transactional(readOnly = true)
1172         public String getDescription(final Long studyId)
1173                         throws InvalidParameterException {
1174                 if (studyId == null) {
1175                         throw new InvalidParameterException(PARAM_STUDY_ID, "null");
1176                 }
1177                 Study study = _studyDAO.get(studyId);
1178                 if (study == null) {
1179                         throw new InvalidParameterException(PARAM_STUDY_ID, studyId
1180                                         .toString());
1181                 }
1182                 return study.getDescription();
1183         }
1184
1185         /**
1186          * {@inheritDoc}
1187          *
1188          * @see org.splat.service.StudyService#setDescription(java.lang.Long, java.lang.String)
1189          */
1190         @Transactional
1191         public void setDescription(final Long studyId, final String descriptionText)
1192                         throws InvalidParameterException {
1193                 if (studyId == null) {
1194                         throw new InvalidParameterException(PARAM_STUDY_ID, "null");
1195                 }
1196                 Study study = _studyDAO.get(studyId);
1197                 if (study == null) {
1198                         throw new InvalidParameterException(PARAM_STUDY_ID, studyId
1199                                         .toString());
1200                 }
1201                 study.setAttribute(new DescriptionAttribute(study, descriptionText));
1202         }
1203
1204         /**
1205          * {@inheritDoc}
1206          *
1207          * @see org.splat.service.StudyService#removeStudyDescription(java.lang.Long)
1208          */
1209         @Transactional
1210         public boolean removeDescription(final Long studyId)
1211                         throws InvalidParameterException {
1212                 if (studyId == null) {
1213                         throw new InvalidParameterException(PARAM_STUDY_ID, String
1214                                         .valueOf(studyId));
1215                 }
1216                 Study study = _studyDAO.get(studyId);
1217                 if (study == null) {
1218                         throw new InvalidParameterException(PARAM_STUDY_ID, String
1219                                         .valueOf(studyId));
1220                 }
1221                 return study.removeAttribute(study
1222                                 .getAttribute(DescriptionAttribute.class));
1223         }
1224
1225         /**
1226          *
1227          * {@inheritDoc}
1228          *
1229          * @see org.splat.service.StudyService#compare(java.util.List)
1230          */
1231         @Override
1232         public String compare(final List<DocToCompareDTO> docsList,
1233                         final String userName) throws IncompatibleDataException {
1234
1235                 String axis1Name = "";
1236                 String axis2Name = "";
1237                 String chartTitle = "";
1238                 String resultPath = "";
1239
1240                 XYSeriesCollection dataset = new XYSeriesCollection();
1241
1242                 Iterator<DocToCompareDTO> docListIter = docsList.iterator();
1243
1244                 for (; docListIter.hasNext();) {
1245
1246                         DocToCompareDTO docDTO = docListIter.next();
1247                         String pathToFile = docDTO.getPathToFile();
1248                         File compDocFile = new File(pathToFile);
1249
1250                         resultPath = pathToFile.substring(0, pathToFile.indexOf("vault"))
1251                                         + "downloads" + File.separator + userName + File.separator
1252                                         + "ComparisonResult.pdf";
1253
1254                         XYSeries series = new XYSeries("Study: " + docDTO.getStudyTitle()
1255                                         + " Scenario: " + docDTO.getScenarioTitle() + " Document: "
1256                                         + docDTO.getDocumentTitle());
1257
1258                         // read the file and get points information.
1259                         try {
1260                                 Scanner input = new Scanner(compDocFile);
1261
1262                                 // get the title of the chart.
1263                                 if (input.hasNext()) {
1264                                         chartTitle = input.nextLine();
1265                                 }
1266
1267                                 // get the name of the axis.
1268                                 if (input.hasNext()) {
1269                                         String[] tokens = input.nextLine().split(",");
1270
1271                                         if (tokens.length < 2) {
1272                                                 throw new IncompatibleDataException(
1273                                                                 MessageKeyEnum.IDT_000001.toString());
1274                                         }
1275
1276                                         if ("".equals(axis1Name)) {
1277                                                 axis1Name = tokens[0];
1278                                         } else if (!axis1Name.equals(tokens[0])) {
1279                                                 LOG.debug("Axis must be the same for all documents");
1280                                                 throw new IncompatibleDataException(
1281                                                                 MessageKeyEnum.IDT_000001.toString());
1282                                         }
1283
1284                                         if ("".equals(axis2Name)) {
1285                                                 axis2Name = tokens[1];
1286                                         } else if (!axis2Name.equals(tokens[1])) {
1287                                                 LOG.debug("Axis must be the same for all documents");
1288                                                 throw new IncompatibleDataException(
1289                                                                 MessageKeyEnum.IDT_000001.toString());
1290                                         }
1291                                 }
1292
1293                                 // Get the XY points series.
1294                                 while (input.hasNext()) {
1295
1296                                         String currentString = input.nextLine();
1297
1298                                         if (!("".equals(currentString))) {
1299                                                 String[] tokens = currentString.split(" ");
1300                                                 series.add(Double.valueOf(tokens[0]), Double
1301                                                                 .valueOf(tokens[1]));
1302                                         }
1303
1304                                 } // while
1305
1306                                 dataset.addSeries(series);
1307
1308                         } catch (FileNotFoundException e) {
1309                                 LOG.error("Sorry, the file is not found.", e);
1310                         }
1311                 } // for
1312
1313                 JFreeChart chart = ChartFactory.createXYLineChart(chartTitle, // Title
1314                                 axis1Name, // x-axis Label
1315                                 axis2Name, // y-axis Label
1316                                 dataset, // Dataset
1317                                 PlotOrientation.VERTICAL, // Plot Orientation
1318                                 true, // Show Legend
1319                                 true, // Use tooltips
1320                                 false // Configure chart to generate URLs?
1321                                 );
1322
1323                 // export to PDF - file.
1324                 int x = 500;
1325                 int y = 300;
1326                 Rectangle pagesize = new Rectangle(x, y);
1327                 Document document = new Document(pagesize, 50, 50, 50, 50);
1328                 PdfWriter writer;
1329                 try {
1330                         File resFile = new File(resultPath);
1331                         File resFolder = new File(resultPath.substring(0, resultPath
1332                                         .lastIndexOf(File.separator)));
1333                         resFolder.mkdirs();
1334                         writer = PdfWriter.getInstance(document, new FileOutputStream(
1335                                         resFile));
1336
1337                         document.open();
1338                         PdfContentByte cb = writer.getDirectContent();
1339                         PdfTemplate tp = cb.createTemplate(x, y);
1340                         Graphics2D g2 = tp.createGraphics(x, y, new DefaultFontMapper());
1341                         chart.draw(g2, new java.awt.Rectangle(x, y));
1342                         g2.dispose();
1343                         cb.addTemplate(tp, 0, 0);
1344                         document.close();
1345
1346                 } catch (FileNotFoundException e) {
1347                         LOG.error("Sorry, the file is not found.", e);
1348                 } catch (DocumentException e) {
1349                         LOG.error("Sorry, the DocumentException is thrown.", e);
1350                 }
1351
1352                 return resultPath;
1353         }
1354
1355         /**
1356          * {@inheritDoc}
1357          * @see org.splat.service.StudyService#getReaders(long)
1358          */
1359         @Transactional(readOnly = true)
1360         public List<UserDTO> getReaders(final long studyId) throws InvalidParameterException {
1361                 Study aStudy = selectStudy(studyId);
1362                 if(aStudy == null){
1363                         throw new InvalidParameterException("studyId", String.valueOf(studyId));
1364                 }
1365                 List<Relation> relations = aStudy.getRelations(ReaderRelation.class);
1366                 List<UserDTO> result = new ArrayList<UserDTO>();
1367                 for(Relation relation : relations){
1368                         result.add(BeanHelper.copyBean(relation.getTo(), UserDTO.class));
1369                 }
1370                 return Collections.unmodifiableList(result);
1371         }
1372
1373         /**
1374          * {@inheritDoc}
1375          * @see org.splat.service.StudyService#addReader(long, long)
1376          */
1377         @Transactional
1378         public boolean addReader(final long studyId, final long userId) throws InvalidParameterException {
1379                 Study aStudy = selectStudy(studyId);
1380                 if(aStudy == null){
1381                         throw new InvalidParameterException("studyId", String.valueOf(studyId));
1382                 }
1383                 User user = _userService.selectUser(userId);
1384                 if(user == null){
1385                         throw new InvalidParameterException("userId", String.valueOf(userId));
1386                 }
1387
1388                 for(Relation relation : aStudy.getRelations(ReaderRelation.class)) {
1389                         if(user.equals(relation.getTo())) {
1390                                 return false;
1391                         }
1392                 }
1393                 aStudy.addRelation(new ReaderRelation(aStudy, user));
1394                 update(aStudy);
1395                 return true;
1396         }
1397
1398         /**
1399          * {@inheritDoc}
1400          * @see org.splat.service.StudyService#removeReader(long, long)
1401          */
1402         @Transactional
1403         public boolean removeReader(final long studyId, final long userId) throws InvalidParameterException {
1404                 Study aStudy = selectStudy(studyId);
1405                 if(aStudy == null){
1406                         throw new InvalidParameterException("studyId", String.valueOf(studyId));
1407                 }
1408                 User user = _userService.selectUser(userId);
1409                 if(user == null){
1410                         throw new InvalidParameterException("userId", String.valueOf(userId));
1411                 }
1412
1413                 Relation relation = aStudy.removeRelation(ReaderRelation.class, user);
1414                 update(aStudy);
1415                 return relation != null;
1416         }
1417
1418         /**
1419          * Get project settings.
1420          *
1421          * @return Project settings service
1422          */
1423         private ProjectSettingsService getProjectSettings() {
1424                 return _projectSettings;
1425         }
1426
1427         /**
1428          * Set project settings service.
1429          *
1430          * @param projectSettingsService
1431          *            project settings service
1432          */
1433         public void setProjectSettings(
1434                         final ProjectSettingsService projectSettingsService) {
1435                 _projectSettings = projectSettingsService;
1436         }
1437
1438         /**
1439          * Get the projectElementService.
1440          *
1441          * @return the projectElementService
1442          */
1443         public ProjectElementService getProjectElementService() {
1444                 return _projectElementService;
1445         }
1446
1447         /**
1448          * Set the projectElementService.
1449          *
1450          * @param projectElementService
1451          *            the projectElementService to set
1452          */
1453         public void setProjectElementService(
1454                         final ProjectElementService projectElementService) {
1455                 _projectElementService = projectElementService;
1456         }
1457
1458         /**
1459          * Get the stepService.
1460          *
1461          * @return the stepService
1462          */
1463         public StepService getStepService() {
1464                 return _stepService;
1465         }
1466
1467         /**
1468          * Set the stepService.
1469          *
1470          * @param stepService
1471          *            the stepService to set
1472          */
1473         public void setStepService(final StepService stepService) {
1474                 _stepService = stepService;
1475         }
1476
1477         /**
1478          * Get the indexService.
1479          *
1480          * @return the indexService
1481          */
1482         public IndexService getIndexService() {
1483                 return _indexService;
1484         }
1485
1486         /**
1487          * Set the indexService.
1488          *
1489          * @param indexService
1490          *            the indexService to set
1491          */
1492         public void setIndexService(final IndexService indexService) {
1493                 _indexService = indexService;
1494         }
1495
1496         /**
1497          * Get the studyDAO.
1498          *
1499          * @return the studyDAO
1500          */
1501         public StudyDAO getStudyDAO() {
1502                 return _studyDAO;
1503         }
1504
1505         /**
1506          * Set the studyDAO.
1507          *
1508          * @param studyDAO
1509          *            the studyDAO to set
1510          */
1511         public void setStudyDAO(final StudyDAO studyDAO) {
1512                 _studyDAO = studyDAO;
1513         }
1514
1515         /**
1516          * Get the iDBuilderDAO.
1517          *
1518          * @return the iDBuilderDAO
1519          */
1520         public IDBuilderDAO getIDBuilderDAO() {
1521                 return _iDBuilderDAO;
1522         }
1523
1524         /**
1525          * Set the iDBuilderDAO.
1526          *
1527          * @param builderDAO
1528          *            the iDBuilderDAO to set
1529          */
1530         public void setIDBuilderDAO(final IDBuilderDAO builderDAO) {
1531                 _iDBuilderDAO = builderDAO;
1532         }
1533
1534         /**
1535          * Get the scenarioDAO.
1536          *
1537          * @return the scenarioDAO
1538          */
1539         public ScenarioDAO getScenarioDAO() {
1540                 return _scenarioDAO;
1541         }
1542
1543         /**
1544          * Set the scenarioDAO.
1545          *
1546          * @param scenarioDAO
1547          *            the scenarioDAO to set
1548          */
1549         public void setScenarioDAO(final ScenarioDAO scenarioDAO) {
1550                 _scenarioDAO = scenarioDAO;
1551         }
1552
1553         /**
1554          * Get the validationCycleDAO.
1555          *
1556          * @return the validationCycleDAO
1557          */
1558         public ValidationCycleDAO getValidationCycleDAO() {
1559                 return _validationCycleDAO;
1560         }
1561
1562         /**
1563          * Set the validationCycleDAO.
1564          *
1565          * @param validationCycleDAO
1566          *            the validationCycleDAO to set
1567          */
1568         public void setValidationCycleDAO(
1569                         final ValidationCycleDAO validationCycleDAO) {
1570                 _validationCycleDAO = validationCycleDAO;
1571         }
1572
1573         /**
1574          * Get the documentTypeService.
1575          *
1576          * @return the documentTypeService
1577          */
1578         public DocumentTypeService getDocumentTypeService() {
1579                 return _documentTypeService;
1580         }
1581
1582         /**
1583          * Set the documentTypeService.
1584          *
1585          * @param documentTypeService
1586          *            the documentTypeService to set
1587          */
1588         public void setDocumentTypeService(
1589                         final DocumentTypeService documentTypeService) {
1590                 _documentTypeService = documentTypeService;
1591         }
1592
1593         /**
1594          * Get the userService.
1595          *
1596          * @return the userService
1597          */
1598         public UserService getUserService() {
1599                 return _userService;
1600         }
1601
1602         /**
1603          * Set the userService.
1604          *
1605          * @param userService
1606          *            the userService to set
1607          */
1608         public void setUserService(final UserService userService) {
1609                 _userService = userService;
1610         }
1611
1612         /**
1613          * {@inheritDoc}
1614          *
1615          * @see org.splat.service.StudyService#getComparableStudies()
1616          */
1617         @Transactional(readOnly = true)
1618         public List<StudyFacadeDTO> getComparableStudies(final long userId)
1619                         throws MismatchException {
1620                 // retrieve the number of the "Analyze the results" step
1621                 List<Step> allSteps = _projectSettings.getAllSteps();
1622                 Step theAnalyzeStep = null;
1623                 for (Step step : allSteps) {
1624                         if (step.getKey().equals("postprocessing")) {
1625                                 theAnalyzeStep = step;
1626                         }
1627                 }
1628                 if (theAnalyzeStep == null) { // TODO: throw some other exception
1629                         throw new MismatchException(
1630                                         "no step with key 'postprocessing' found."
1631                                                         + "Probably, customization settings have been changed.");
1632                 }
1633
1634                 List<Publication> publications = _publicationDAO.getFilteredList(
1635                                 "mydoc", Restrictions.eq("step", Integer.valueOf(theAnalyzeStep
1636                                                 .getNumber())));
1637
1638                 // split retrieved publications into groups by studies and scenarios
1639                 Map<Study, List<ProjectElement>> studyMap = new HashMap<Study, List<ProjectElement>>();
1640                 Map<ProjectElement, List<Publication>> scenarioMap = new HashMap<ProjectElement, List<Publication>>();
1641
1642                 for (Publication publication : publications) {
1643                         // filter out publications corresponding to a document of given step which is not a _result_ document
1644                         if (!publication.value().getType().isResultOf(theAnalyzeStep)
1645                                         || !"srd".equals(publication.getSourceFile().getFormat())) {
1646                                 continue;
1647                         }
1648
1649                         // check the study visibility to the user
1650                         if (!isStaffedBy(publication.getOwnerStudy(), _userService
1651                                         .selectUser(userId))
1652                                         && Visibility.PUBLIC.equals(publication.getOwnerStudy()
1653                                                         .getVisibility())) {
1654                                 continue;
1655                         }
1656
1657                         Study study = publication.getOwnerStudy();
1658                         ProjectElement scenario = publication.getOwner();
1659
1660                         Hibernate.initialize(scenario);
1661                         if (scenario instanceof HibernateProxy) {
1662                                 scenario = (ProjectElement) ((HibernateProxy) scenario)
1663                                                 .getHibernateLazyInitializer().getImplementation();
1664                         }
1665
1666                         if (!(scenario instanceof Scenario)) {
1667                                 throw new MismatchException(
1668                                                 "publications from postprocessing step are supposed to have owner scenario");
1669                         }
1670
1671                         if (!studyMap.containsKey(study)) {
1672                                 studyMap.put(study, new ArrayList<ProjectElement>());
1673                         }
1674
1675                         if (!studyMap.get(study).contains(scenario)) {
1676                                 studyMap.get(study).add(scenario);
1677                         }
1678
1679                         if (!scenarioMap.containsKey(scenario)) {
1680                                 scenarioMap.put(scenario, new ArrayList<Publication>());
1681                         }
1682                         scenarioMap.get(scenario).add(publication);
1683                 }
1684
1685                 // Create the result DTOs
1686                 List<StudyFacadeDTO> result = new ArrayList<StudyFacadeDTO>();
1687                 for (Study study : studyMap.keySet()) {
1688
1689                         StudyFacadeDTO studyDTO = new StudyFacadeDTO();
1690                         studyDTO.setName(study.getTitle());
1691                         studyDTO.setScenarios(new ArrayList<StudyFacadeDTO.ScenarioDTO>());
1692                         result.add(studyDTO);
1693
1694                         for (ProjectElement scenario : studyMap.get(study)) {
1695
1696                                 StudyFacadeDTO.ScenarioDTO scenarioDTO = new StudyFacadeDTO.ScenarioDTO();
1697                                 scenarioDTO.setName(scenario.getTitle());
1698                                 scenarioDTO.setDocs(new ArrayList<DocumentDTO>());
1699                                 studyDTO.getScenarios().add(scenarioDTO);
1700
1701                                 for (Publication publication : scenarioMap.get(scenario)) {
1702
1703                                         DocumentDTO documentDTO = new DocumentDTO();
1704                                         documentDTO.setId(publication.getIndex());
1705                                         documentDTO.setTitle(publication.value().getTitle());
1706
1707                                         scenarioDTO.getDocs().add(documentDTO);
1708                                 }
1709                         }
1710                 }
1711                 return result;
1712         }
1713
1714         /**
1715          * Get the publicationDAO.
1716          *
1717          * @return the publicationDAO
1718          */
1719         public PublicationDAO getPublicationDAO() {
1720                 return _publicationDAO;
1721         }
1722
1723         /**
1724          * Set the publicationDAO.
1725          *
1726          * @param publicationDAO
1727          *            the publicationDAO to set
1728          */
1729         public void setPublicationDAO(final PublicationDAO publicationDAO) {
1730                 _publicationDAO = publicationDAO;
1731         }
1732
1733         /**
1734          * Get the repositoryService.
1735          *
1736          * @return the repositoryService
1737          */
1738         public RepositoryService getRepositoryService() {
1739                 return _repositoryService;
1740         }
1741
1742         /**
1743          * Set the repositoryService.
1744          *
1745          * @param repositoryService
1746          *            the repositoryService to set
1747          */
1748         public void setRepositoryService(final RepositoryService repositoryService) {
1749                 _repositoryService = repositoryService;
1750         }
1751
1752         /**
1753          * Get the documentDAO.
1754          *
1755          * @return the documentDAO
1756          */
1757         public DocumentDAO getDocumentDAO() {
1758                 return _documentDAO;
1759         }
1760
1761         /**
1762          * Set the documentDAO.
1763          *
1764          * @param documentDAO
1765          *            the documentDAO to set
1766          */
1767         public void setDocumentDAO(final DocumentDAO documentDAO) {
1768                 _documentDAO = documentDAO;
1769         }
1770
1771         /**
1772          * Get the descriptionAttributeDAO.
1773          *
1774          * @return the descriptionAttributeDAO
1775          */
1776         public DescriptionAttributeDAO getDescriptionAttributeDAO() {
1777                 return _descriptionAttributeDAO;
1778         }
1779
1780         /**
1781          * Set the descriptionAttributeDAO.
1782          *
1783          * @param descriptionAttributeDAO
1784          *            the descriptionAttributeDAO to set
1785          */
1786         public void setDescriptionAttributeDAO(
1787                         final DescriptionAttributeDAO descriptionAttributeDAO) {
1788                 _descriptionAttributeDAO = descriptionAttributeDAO;
1789         }
1790
1791         /**
1792          * Get the usedByRelationDAO.
1793          *
1794          * @return the usedByRelationDAO
1795          */
1796         public UsedByRelationDAO getUsedByRelationDAO() {
1797                 return _usedByRelationDAO;
1798         }
1799
1800         /**
1801          * Set the usedByRelationDAO.
1802          *
1803          * @param usedByRelationDAO
1804          *            the usedByRelationDAO to set
1805          */
1806         public void setUsedByRelationDAO(final UsedByRelationDAO usedByRelationDAO) {
1807                 _usedByRelationDAO = usedByRelationDAO;
1808         }
1809
1810 }