/**
   * Create an internalTaskFlow job with the given task flow job (user)
   *
   * @param userJob the user job that will be used to create the internal job.
   * @return the created internal job.
   * @throws JobCreationException an exception if the factory cannot create the given job.
   */
  private static InternalJob createJob(TaskFlowJob userJob) throws JobCreationException {
    if (userJob.getTasks().size() == 0) {
      logger.info("Job '" + userJob.getName() + "' must contain tasks !");
      throw new JobCreationException("This job must contains tasks !");
    }

    // validate taskflow
    List<FlowChecker.Block> blocks = new ArrayList<>();
    FlowError err = FlowChecker.validate(userJob, blocks);
    if (err != null) {
      String e = "";

      e += "Invalid taskflow: " + err.getMessage() + "; context: " + err.getTask();
      logger.error(e);
      throw new JobCreationException(e, err);
    }

    InternalJob job = new InternalTaskFlowJob();
    // keep an initial job content
    job.setTaskFlowJob(userJob);
    Map<Task, InternalTask> tasksList = new LinkedHashMap<>();
    boolean hasPreciousResult = false;

    for (Task t : userJob.getTasks()) {
      tasksList.put(t, createTask(userJob, t));

      if (!hasPreciousResult) {
        hasPreciousResult = t.isPreciousResult();
      }
    }

    for (Entry<Task, InternalTask> entry : tasksList.entrySet()) {
      if (entry.getKey().getDependencesList() != null) {
        for (Task t : entry.getKey().getDependencesList()) {
          entry.getValue().addDependence(tasksList.get(t));
        }
      }

      job.addTask(entry.getValue());
    }

    // tag matching blocks in InternalTasks
    for (InternalTask it : tasksList.values()) {
      for (FlowChecker.Block block : blocks) {
        if (it.getName().equals(block.start.element.getName())) {
          it.setMatchingBlock(block.end.element.getName());
        }
        if (it.getName().equals(block.end.element.getName())) {
          it.setMatchingBlock(block.start.element.getName());
        }
      }
    }

    // create if/else/join weak dependencies
    for (InternalTask it : tasksList.values()) {

      // it performs an IF action
      if (it.getFlowScript() != null
          && it.getFlowScript().getActionType().equals(FlowActionType.IF.toString())) {
        String ifBranch = it.getFlowScript().getActionTarget();
        String elseBranch = it.getFlowScript().getActionTargetElse();
        String join = it.getFlowScript().getActionContinuation();
        List<InternalTask> joinedBranches = new ArrayList<>();

        // find the ifBranch task
        for (InternalTask it2 : tasksList.values()) {
          if (it2.getName().equals(ifBranch)) {
            it2.setIfBranch(it);
            String match = it2.getMatchingBlock();
            // find its matching block task
            if (match == null) {
              // no match: single task
              joinedBranches.add(it2);
            } else {
              for (InternalTask it3 : tasksList.values()) {
                if (it3.getName().equals(match)) {
                  joinedBranches.add(it3);
                  break;
                }
              }
            }
            break;
          }
        }

        // find the elseBranch task
        for (InternalTask it2 : tasksList.values()) {
          if (it2.getName().equals(elseBranch)) {
            it2.setIfBranch(it);

            String match = it2.getMatchingBlock();
            // find its matching block task
            if (match == null) {
              // no match: single task
              joinedBranches.add(it2);
            } else {
              for (InternalTask it3 : tasksList.values()) {
                if (it3.getName().equals(match)) {
                  joinedBranches.add(it3);
                  break;
                }
              }
            }
            break;
          }
        }

        // find the joinBranch task
        for (InternalTask it2 : tasksList.values()) {
          if (it2.getName().equals(join)) {
            it2.setJoinedBranches(joinedBranches);
          }
        }
      }
    }
    return job;
  }
  /** Creates the "job" element <define name="job"> */
  private Element createRootJobElement(Document doc, TaskFlowJob job) {
    Element rootJob = doc.createElementNS(Schemas.SCHEMA_LATEST.namespace, "job");

    // ********** attributes ***********
    rootJob.setAttributeNS(
        "http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation", XSD_LOCATION);
    setAttribute(rootJob, XMLAttributes.JOB_PROJECT_NAME, job.getProjectName(), true);
    setAttribute(rootJob, XMLAttributes.JOB_PRIORITY, job.getPriority().toString());
    if (job.getOnTaskErrorProperty().isSet()) {
      setAttribute(
          rootJob,
          XMLAttributes.COMMON_ON_TASK_ERROR,
          job.getOnTaskErrorProperty().getValue().toString(),
          true);
    }
    if (job.getMaxNumberOfExecutionProperty().isSet()) {
      setAttribute(
          rootJob,
          XMLAttributes.COMMON_MAX_NUMBER_OF_EXECUTION,
          Integer.toString(job.getMaxNumberOfExecution()));
    }
    setAttribute(rootJob, XMLAttributes.COMMON_NAME, job.getName(), true);
    if (job.getRestartTaskOnErrorProperty().isSet()) {
      setAttribute(
          rootJob,
          XMLAttributes.COMMON_RESTART_TASK_ON_ERROR,
          job.getRestartTaskOnError().toString());
    }

    // *** elements ***

    // <ref name="variables"/>
    if (job.getVariables() != null && !job.getVariables().isEmpty()) {
      Element variablesE = createVariablesElement(doc, job.getVariables());
      rootJob.appendChild(variablesE);
    }

    // <ref name="jobDescription"/>
    if (job.getDescription() != null) {
      Element descrNode =
          createElement(doc, XMLTags.COMMON_DESCRIPTION.getXMLName(), job.getDescription());
      rootJob.appendChild(descrNode);
    }

    // <ref name="genericInformation"/>
    if ((job.getGenericInformation() != null) && (job.getGenericInformation().size() > 0)) {
      Element genericInfo = createGenericInformation(doc, job.getGenericInformation());
      rootJob.appendChild(genericInfo);
    }

    // <ref name="inputSpace"/>
    if (job.getInputSpace() != null) {
      Element inputspace =
          createElement(
              doc,
              XMLTags.DS_INPUT_SPACE.getXMLName(),
              null,
              new Attribute(XMLAttributes.DS_URL.getXMLName(), job.getInputSpace()));
      rootJob.appendChild(inputspace);
    }

    // <ref name="outputSpace"/>
    if (job.getOutputSpace() != null) {
      Element outputSpace =
          createElement(
              doc,
              XMLTags.DS_OUTPUT_SPACE.getXMLName(),
              null,
              new Attribute(XMLAttributes.DS_URL.getXMLName(), job.getOutputSpace()));
      rootJob.appendChild(outputSpace);
    }

    // <ref name="globalSpace"/>
    if (job.getGlobalSpace() != null) {
      Element globalSpace =
          createElement(
              doc,
              XMLTags.DS_GLOBAL_SPACE.getXMLName(),
              null,
              new Attribute(XMLAttributes.DS_URL.getXMLName(), job.getGlobalSpace()));
      rootJob.appendChild(globalSpace);
    }

    // <ref name="userSpace"/>
    if (job.getUserSpace() != null) {
      Element userSpace =
          createElement(
              doc,
              XMLTags.DS_USER_SPACE.getXMLName(),
              null,
              new Attribute(XMLAttributes.DS_URL.getXMLName(), job.getUserSpace()));
      rootJob.appendChild(userSpace);
    }

    // <ref name="taskFlow"/>
    Element taskFlow = createTaskFlowElement(doc, job);
    rootJob.appendChild(taskFlow);

    return rootJob;
  }