feat: codelists endpoints

pom.xml

@@ -13,7 +13,7 @@
 	<groupId>fr.insee</groupId>
 	<artifactId>Pogues-BO</artifactId>
 	<packaging>jar</packaging>
-	<version>4.11.2</version>
+	<version>4.12.0-SNAPSHOT.6</version>
 	<name>Pogues-Back-Office</name>
 
 	<properties>

src/main/java/fr/insee/pogues/api/remote/eno/transforms/EnoClient.java

@@ -1,7 +1,7 @@
 package fr.insee.pogues.api.remote.eno.transforms;
 
 import fr.insee.pogues.exception.EnoException;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -19,14 +19,14 @@ public interface EnoClient {
 
 	String getDDIToODT (String inputAsString) throws EnoException, PoguesException;
 
-	String getDDIToFO(String inputAsString) throws URISyntaxException, IOException, EnoException;
+	String getDDIToFO(String inputAsString) throws URISyntaxException, IOException, EnoException, PoguesException;
 
-	String getDDIToXForms(String inputAsString) throws URISyntaxException, IOException, EnoException;
+	String getDDIToXForms(String inputAsString) throws URISyntaxException, IOException, EnoException, PoguesException;
 
 	/** @deprecated Use Pogues to Lunatic method instead. */
 	@Deprecated(since = "4.9.2")
-	String getDDIToLunaticJSON(String inputAsString, Map<String, Object> params) throws URISyntaxException, IOException, EnoException;
+	String getDDIToLunaticJSON(String inputAsString, Map<String, Object> params) throws URISyntaxException, IOException, EnoException, PoguesException;
 
-	String getPoguesJsonToLunaticJson(String inputAsString, Map<String, Object> params) throws URISyntaxException, IOException, EnoException;
+	String getPoguesJsonToLunaticJson(String inputAsString, Map<String, Object> params) throws URISyntaxException, IOException, EnoException, PoguesException;
 
 }

src/main/java/fr/insee/pogues/api/remote/eno/transforms/EnoHttpClient.java

@@ -2,7 +2,7 @@
 
 import fr.insee.pogues.exception.EnoException;
 import fr.insee.pogues.webservice.model.EnoContext;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Value;
@@ -96,7 +96,7 @@ public String getDDIToLunaticJSON(String inputAsString, Map<String, Object> para
     }
 
     @Override
-    public String getPoguesJsonToLunaticJson(String inputAsString, Map<String, Object> params) throws IOException, EnoException {
+    public String getPoguesJsonToLunaticJson(String inputAsString, Map<String, Object> params) throws EnoException, PoguesException {
         log.info("getJSONPoguesToLunaticJson - started");
 
         EnoContext context = getContextParam(params);

src/main/java/fr/insee/pogues/exception/CodesListException.java

@@ -0,0 +1,24 @@
+package fr.insee.pogues.exception;
+
+import fr.insee.pogues.webservice.error.ApiMessage;
+import fr.insee.pogues.webservice.error.CodesListMessage;
+import lombok.Getter;
+
+import java.util.List;
+
+@Getter
+public class CodesListException extends PoguesException {
+
+    private List<String> questionIds;
+
+    public CodesListException(int status, String message, String details, List<String> questionIds) {
+       super(status, message, details);
+       this.questionIds = questionIds;
+    }
+
+    @Override
+    public ApiMessage toApiMessage(){
+        return new CodesListMessage(this.getStatus(), this.getMessage(),this.getDetails(), questionIds);
+    }
+
+}

src/main/java/fr/insee/pogues/exception/GenericException.java

@@ -0,0 +1,19 @@
+package fr.insee.pogues.exception;
+
+import fr.insee.pogues.webservice.error.ApiMessage;
+import lombok.Getter;
+
+@Getter
+public abstract class GenericException extends Exception {
+
+    private String details;
+
+    public GenericException(String message, String details){
+        super(message);
+        this.details = details;
+    }
+
+    public ApiMessage toApiMessage() {
+        return new ApiMessage(500, this.getMessage(), details);
+    }
+}

src/main/java/fr/insee/pogues/exception/PoguesException.java

@@ -0,0 +1,28 @@
+package fr.insee.pogues.exception;
+
+import fr.insee.pogues.webservice.error.ApiMessage;
+import lombok.Getter;
+
+@Getter
+public class PoguesException extends GenericException {
+
+    private int status;
+    private String details;
+
+    /**
+     *
+     * @param status
+     * @param message
+     * @param details
+     */
+    public PoguesException(int status, String message, String details) {
+        super(message, details);
+        this.status = status;
+        this.details = details;
+    }
+
+    @Override
+    public ApiMessage toApiMessage(){
+        return new ApiMessage(this.status, this.getMessage(), this.details);
+    }
+}

src/main/java/fr/insee/pogues/metadata/client/DDIASClientImpl.java

@@ -1,7 +1,7 @@
 package fr.insee.pogues.metadata.client;
 
 import fr.insee.pogues.metadata.model.ddias.Unit;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;

src/main/java/fr/insee/pogues/metadata/client/MagmaClientImpl.java

@@ -2,7 +2,7 @@
 
 import fr.insee.pogues.metadata.model.magma.Operation;
 import fr.insee.pogues.metadata.model.magma.Serie;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;

src/main/java/fr/insee/pogues/persistence/impl/QuestionnairePostgresql.java

@@ -5,7 +5,7 @@
 import fr.insee.pogues.configuration.auth.security.restrictions.StampsRestrictionsService;
 import fr.insee.pogues.configuration.cache.CacheName;
 import fr.insee.pogues.persistence.repository.QuestionnaireRepository;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.extern.slf4j.Slf4j;
 import org.postgresql.util.PGobject;
 import org.springframework.beans.factory.annotation.Autowired;

src/main/java/fr/insee/pogues/persistence/impl/VersionPostgresql.java

@@ -2,12 +2,11 @@
 
 import fr.insee.pogues.domain.entity.db.Version;
 import fr.insee.pogues.persistence.repository.QuestionnaireVersionRepository;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.extern.slf4j.Slf4j;
 import org.postgresql.util.PGobject;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.dao.DataAccessException;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.stereotype.Service;

src/main/java/fr/insee/pogues/persistence/service/QuestionnairesServiceImpl.java

@@ -10,8 +10,7 @@
 import fr.insee.pogues.transforms.visualize.composition.QuestionnaireComposition;
 import fr.insee.pogues.utils.PoguesDeserializer;
 import fr.insee.pogues.utils.PoguesSerializer;
-import fr.insee.pogues.utils.json.JSONFunctions;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;

src/main/java/fr/insee/pogues/service/CodesListService.java

@@ -0,0 +1,164 @@
+package fr.insee.pogues.service;
+
+import fr.insee.pogues.exception.CodesListException;
+import fr.insee.pogues.model.*;
+import fr.insee.pogues.persistence.service.QuestionnairesService;
+import fr.insee.pogues.utils.PoguesDeserializer;
+import fr.insee.pogues.utils.PoguesSerializer;
+import fr.insee.pogues.webservice.model.dtd.codeList.CodesList;
+import fr.insee.pogues.exception.PoguesException;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.Function;
+import java.util.function.Predicate;
+
+import static fr.insee.pogues.utils.CodesListConverter.*;
+import static fr.insee.pogues.utils.json.JSONFunctions.jsonStringtoJsonNode;
+import static fr.insee.pogues.utils.model.CodesList.getListOfQuestionIdWhereCodesListIsUsed;
+import static fr.insee.pogues.utils.model.CodesList.getListOfQuestionWhereCodesListIsUsed;
+import static fr.insee.pogues.utils.model.Variables.getNeededCollectedVariablesInQuestionnaire;
+import static fr.insee.pogues.utils.model.question.Common.removeClarificationQuestion;
+import static fr.insee.pogues.utils.model.question.MultipleChoice.updateMultipleChoiceQuestionAccordingToCodeList;
+import static fr.insee.pogues.utils.model.question.Table.updateTableQuestionAccordingToCodeList;
+
+@Service
+@Slf4j
+public class CodesListService {
+    private QuestionnairesService questionnairesService;
+
+    @Autowired
+    public CodesListService(QuestionnairesService questionnairesService){
+        this.questionnairesService = questionnairesService;
+    }
+
+    /**
+     *
+     * @param questionnaireId
+     * @param idCodesList
+     * @param codesList
+     * @return the list of question's id updated (or null if created)
+     * @throws Exception
+     */
+    public List<String> updateOrAddCodeListToQuestionnaire(String questionnaireId, String idCodesList, CodesList codesList) throws Exception {
+        Questionnaire questionnaire = retrieveQuestionnaireWithId(questionnaireId);
+        List<String> updatedQuestionIds = updateOrAddCodeListToQuestionnaire(questionnaire, idCodesList, codesList);
+        updateQuestionnaireInDataBase(questionnaire);
+        return updatedQuestionIds;
+    }
+    /**
+     *
+     * @param questionnaire
+     * @param idCodesList
+     * @param codesList
+     * @return the list of question's id updated (or null if created)
+     * @throws Exception
+     */
+    public List<String> updateOrAddCodeListToQuestionnaire(Questionnaire questionnaire, String idCodesList, CodesList codesList) {
+        List<fr.insee.pogues.model.CodeList> codesLists = questionnaire.getCodeLists().getCodeList();
+        boolean created = updateOrAddCodeListDTD(codesLists, idCodesList, codesList);
+        if(!created)  return updateQuestionAndVariablesAccordingToCodesList(questionnaire, idCodesList);
+        return null;
+    }
+
+    public void deleteCodeListOfQuestionnaireWithId(String questionnaireId, String codesListId) throws Exception {
+        Questionnaire questionnaire = retrieveQuestionnaireWithId(questionnaireId);
+        deleteCodeListOfQuestionnaire(questionnaire, codesListId);
+        updateQuestionnaireInDataBase(questionnaire);
+    }
+
+    public void deleteCodeListOfQuestionnaire(Questionnaire questionnaire, String codesListId) throws Exception {
+        List<String> questionIds = getListOfQuestionIdWhereCodesListIsUsed(questionnaire, codesListId);
+        if(!questionIds.isEmpty()){
+            throw new CodesListException(400, String.format("CodesList with id %s is required.", codesListId), "", questionIds);
+
+        }
+        List<fr.insee.pogues.model.CodeList> codesLists = questionnaire.getCodeLists().getCodeList();
+        removeCodeListDTD(codesLists, codesListId);
+    }
+
+    private Questionnaire retrieveQuestionnaireWithId(String id) throws Exception {
+        return PoguesDeserializer.questionnaireToJavaObject(questionnairesService.getQuestionnaireByID(id));
+    }
+
+    private void updateQuestionnaireInDataBase(Questionnaire questionnaire) throws Exception {
+        questionnairesService.updateQuestionnaire(
+                questionnaire.getId(),
+                jsonStringtoJsonNode(PoguesSerializer.questionnaireJavaToString(questionnaire)));
+    }
+
+    /**
+     *
+     * @param existingCodeLists
+     * @param idCodesList
+     * @param codesListDtdToUpdate
+     * @return true if new codeList is created
+     */
+    boolean updateOrAddCodeListDTD(List<CodeList> existingCodeLists, String idCodesList, CodesList codesListDtdToUpdate) {
+        if(existingCodeLists.stream().noneMatch(codeList -> Objects.equals(idCodesList, codeList.getId()))){
+            addCodeListDTD(existingCodeLists, codesListDtdToUpdate);
+            return true;
+        }
+        codesListDtdToUpdate.setId(idCodesList);
+        replaceElementInListAccordingCondition(
+                existingCodeLists,
+                codeList -> Objects.equals(idCodesList, codeList.getId()),
+                codesListDtdToUpdate,
+                codesList -> convertFromCodeListDTDtoCodeListModel(codesListDtdToUpdate));
+        return false;
+    }
+
+
+    void addCodeListDTD(List<CodeList> existingCodeLists, CodesList codesListDtdToAdd){
+        existingCodeLists.add(convertFromCodeListDTDtoCodeListModel(codesListDtdToAdd));
+    }
+
+    void removeCodeListDTD(List<CodeList> existingCodeLists, String id) throws CodesListException {
+        boolean deleted = existingCodeLists.removeIf(codeList -> id.equals(codeList.getId()));
+        if(!deleted) throw new CodesListException(404, "Not found", String.format("CodesList with id %s doesn't exist in questionnaire", id),null);
+    }
+
+    List<String> updateQuestionAndVariablesAccordingToCodesList(Questionnaire questionnaire, String updatedCodeListId){
+        // Retrieve updatedCodeList in questionnaire
+        CodeList codeList = questionnaire.getCodeLists().getCodeList().stream().filter(cL -> updatedCodeListId.equals(cL.getId())).findFirst().get();
+        // Just retrieve MULTIPLE_CHOICE and TABLE questions
+        List<QuestionType> questionsToModify = getListOfQuestionWhereCodesListIsUsed(questionnaire, updatedCodeListId);
+        // Clear Clarification question for concerned question
+        questionsToModify.forEach(question -> removeClarificationQuestion(question));
+        // modify Multiple and Table question and get there new Variables
+        List<QuestionType> multipleAndTableQuestion = questionsToModify.stream()
+                .filter(questionType -> {
+                    QuestionTypeEnum questionTypeEnum = questionType.getQuestionType();
+                    return QuestionTypeEnum.MULTIPLE_CHOICE.equals(questionTypeEnum) || QuestionTypeEnum.TABLE.equals(questionTypeEnum);})
+                .toList();
+        List<VariableType> variables = multipleAndTableQuestion.stream()
+                .map(questionType -> {
+                    QuestionTypeEnum questionTypeEnum = questionType.getQuestionType();
+                    if(QuestionTypeEnum.MULTIPLE_CHOICE.equals(questionTypeEnum)) return updateMultipleChoiceQuestionAccordingToCodeList(questionType, codeList);
+                    return updateTableQuestionAccordingToCodeList(questionType, codeList, questionnaire.getCodeLists().getCodeList());
+                })
+                .flatMap(Collection::stream)
+                .toList();
+        // add new variables to questionnaire
+        questionnaire.getVariables().getVariable().addAll(variables);
+        // Delete variables that are not referenced in response
+        List<String> neededCollectedVariables = getNeededCollectedVariablesInQuestionnaire(questionnaire);
+        questionnaire.getVariables().getVariable().removeIf(variableType -> !neededCollectedVariables.contains(variableType.getId()));
+        return questionsToModify.stream().map(question -> question.getId()).toList();
+    }
+
+    private <T,G> void replaceElementInListAccordingCondition(List<T> elements, Predicate<T> conditionFunction, G newElement, Function<G,T> factory){
+        for (int i = 0; i < elements.size(); i++) {
+            T element = elements.get(i);
+            if (conditionFunction.test(element)) {
+                elements.set(i, factory.apply(newElement));
+                break;
+            }
+        }
+    }
+
+}

src/main/java/fr/insee/pogues/transforms/visualize/composition/InsertSequences.java

@@ -6,7 +6,7 @@
 
 import java.util.List;
 
-import static fr.insee.pogues.utils.PoguesModelUtils.getSequences;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getSequences;
 
 /**
  * Implementation of CompositionStep to replace questionnaire reference by its sequences.

src/main/java/fr/insee/pogues/transforms/visualize/composition/UpdateFlowControlBounds.java

@@ -9,8 +9,8 @@
 
 import java.util.List;
 
-import static fr.insee.pogues.utils.PoguesModelUtils.getFlowControlBounds;
-import static fr.insee.pogues.utils.PoguesModelUtils.getSequences;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getFlowControlBounds;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getSequences;
 
 /**
  * Implementation of CompositionStep to update FlowControl (filters) objects when de-referencing a questionnaire.

src/main/java/fr/insee/pogues/transforms/visualize/composition/UpdateIterationBounds.java

@@ -9,8 +9,8 @@
 
 import java.util.List;
 
-import static fr.insee.pogues.utils.PoguesModelUtils.getIterationBounds;
-import static fr.insee.pogues.utils.PoguesModelUtils.getSequences;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getIterationBounds;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getSequences;
 
 /**
  * Implementation of CompositionStep to update Iteration (loops) objects when de-referencing a questionnaire.

src/main/java/fr/insee/pogues/transforms/visualize/composition/UpdateReferencedVariablesScope.java

@@ -6,12 +6,12 @@
 import fr.insee.pogues.model.IterationType;
 import fr.insee.pogues.model.Questionnaire;
 import fr.insee.pogues.model.VariableType;
-import fr.insee.pogues.utils.PoguesModelUtils;
+import fr.insee.pogues.utils.model.PoguesModelUtils;
 import lombok.extern.slf4j.Slf4j;
 
 import java.util.List;
 
-import static fr.insee.pogues.utils.PoguesModelUtils.getIterationBounds;
+import static fr.insee.pogues.utils.model.PoguesModelUtils.getIterationBounds;
 
 /**
  * Implementation of CompositionStep to update variable scopes when de-referencing a questionnaire.

src/main/java/fr/insee/pogues/transforms/visualize/uri/LunaticJSONToUriQueenImpl.java

@@ -3,7 +3,7 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import fr.insee.pogues.persistence.service.QuestionnairesService;
 import fr.insee.pogues.utils.suggester.SuggesterVisuService;
-import fr.insee.pogues.webservice.rest.PoguesException;
+import fr.insee.pogues.exception.PoguesException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;