feat: add source variable references to handle pairwise global variables

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>fr.insee.pogues</groupId>
 	<artifactId>pogues-model</artifactId>
-	<version>1.13.1</version>
+	<version>1.14.0</version>
 	<packaging>jar</packaging>
 
 	<name>Pogues Model</name>

src/main/resources/xsd/Questionnaire.xsd

@@ -6,6 +6,7 @@
 
   <xs:include schemaLocation="articulation/Articulation.xsd"/>
   <xs:include schemaLocation="multimode/Multimode.xsd"/>
+  <xs:include schemaLocation="pairwise/Pairwise.xsd"/>
   <xs:include schemaLocation="TypesUtils.xsd"/>
 
   <xs:annotation>
@@ -220,6 +221,12 @@
             </xs:annotation>
           </xs:element>
           <xs:element name="Scope" type="xs:token" minOccurs="0"/>
+          <xs:element name="sourceVariableReferences" type="SourceVariableReferences" minOccurs="0">
+            <xs:annotation>
+              <xs:documentation>References of variables used by pairwise
+              questions to define the indivisuals.</xs:documentation>
+            </xs:annotation>
+          </xs:element>
           <xs:element name="codeFilters" type="CodeFilter" minOccurs="0" maxOccurs="unbounded">
             <xs:annotation>
               <xs:documentation>codeFilters is list of CodeFilter, indicate in this question,

src/main/resources/xsd/multimode/Multimode.xsd

@@ -23,7 +23,6 @@
         </xs:restriction>
     </xs:simpleType>
 
-
     <xs:complexType name="Rule">
         <xs:sequence>
             <xs:element name="name" type="MultimodeRuleNameEnum"/>

src/main/resources/xsd/pairwise/Pairwise.xsd

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+
+    <xs:include schemaLocation="../TypesUtils.xsd"/>
+
+    <xs:complexType name="SourceVariableReferences">
+        <xs:annotation>
+          <xs:documentation>A pairwise question is defined from source variables
+          which allow to know the individuals we are specifying the links of.
+          </xs:documentation>
+          <xs:documentation>The name source variable allow to ask the question
+          "what is he nature of the relationship between A and B?".
+          </xs:documentation>
+          <xs:documentation>The gender and age source variable allow to compute
+          additional information about the indivisuals (to display a recap or to
+          generate complex variables to create filters from).</xs:documentation>
+        </xs:annotation>
+        <xs:sequence>
+            <xs:element name="name" type="xs:token"/>
+            <xs:element name="gender" type="xs:token" minOccurs="0"/>
+            <xs:element name="age" type="xs:token" minOccurs="0"/>
+        </xs:sequence>
+    </xs:complexType>
+
+</xs:schema>

src/test/java/fr/insee/pogues/test/JSONDeserializerTest.java

@@ -377,4 +377,35 @@ void testExternalVariableIsDeletedOnReset() throws JAXBException {
         assertEquals("NUMERO_MENAGE", externalVariableType.getName());
         assertTrue(externalVariableType.isDeletedOnReset());
     }
+
+    @Test
+    void testPairwiseSourceVariableReferences() throws JAXBException {
+				// Given the JSON of a question with sourceVariableReferences
+        String json = """
+            {
+							"Child": [
+								{
+									"type": "QuestionType",
+									"sourceVariableReferences": {
+										"name": "var-name-id",
+										"gender": "var-gender-id",
+										"age": "var-age-id"
+									}
+								}
+							]
+            }
+            """;
+
+				// When it is deserialized
+        JSONDeserializer deserializer = new JSONDeserializer();
+        Questionnaire questionnaire = deserializer.deserializeString(json);
+
+				// Then the sourceVariableReferences are correctly deserialized
+        QuestionType pairwiseQuestion = (QuestionType) questionnaire.getChild().getFirst();
+
+        assertNotNull(pairwiseQuestion);
+        assertEquals("var-name-id", pairwiseQuestion.getSourceVariableReferences().getName());
+        assertEquals("var-gender-id", pairwiseQuestion.getSourceVariableReferences().getGender());
+        assertEquals("var-age-id", pairwiseQuestion.getSourceVariableReferences().getAge());
+    }
 }

src/test/java/fr/insee/pogues/test/JSONSerializerTest.java

@@ -4,6 +4,7 @@
 import fr.insee.pogues.mock.*;
 import fr.insee.pogues.model.*;
 import org.apache.commons.io.FileUtils;
+import org.apache.logging.log4j.core.util.Source;
 import org.json.JSONException;
 import org.junit.jupiter.api.Test;
 import org.skyscreamer.jsonassert.JSONAssert;
@@ -638,4 +639,41 @@ void serializeExternalVariableIsDeletedOnReset() throws JAXBException, Unsupport
 
         JSONAssert.assertEquals(expectedJson, result, JSONCompareMode.STRICT);
     }
+
+    @Test
+    void serializePairwiseSourceVariableReferences() throws JAXBException, UnsupportedEncodingException, JSONException {
+				// Given a questionnaire with a question with sourceVariableReferences
+        Questionnaire questionnaire = new Questionnaire();
+
+        QuestionType pairwiseQuestion = new QuestionType();
+				SourceVariableReferences sourceVariableReferences = new SourceVariableReferences();
+				sourceVariableReferences.setName("var-name-id");
+				sourceVariableReferences.setGender("var-gender-id");
+				sourceVariableReferences.setAge("var-age-id");
+				pairwiseQuestion.setSourceVariableReferences(sourceVariableReferences);
+
+				questionnaire.getChild().add(pairwiseQuestion);
+
+				// When it is serialized
+        JSONSerializer serializer = new JSONSerializer(true);
+        String result = serializer.serialize(questionnaire);
+
+        String expectedJson = """
+            {
+							"Child": [
+								{
+									"type": "QuestionType",
+									"sourceVariableReferences": {
+										"name": "var-name-id",
+										"gender": "var-gender-id",
+										"age": "var-age-id"
+									}
+								}
+							]
+            }
+            """;
+
+				// Then the sourceVariableReferences are correctly serialized
+        JSONAssert.assertEquals(expectedJson, result, JSONCompareMode.STRICT);
+    }
 }