feat: suggester complex type

pom.xml

@@ -4,9 +4,10 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>fr.insee.lunatic</groupId>
 	<artifactId>lunatic-model</artifactId>
+	<version>2.4.0-SNAPSHOT</version>
+
 	<packaging>jar</packaging>
 
-	<version>2.3.5</version>
 	<name>Lunatic Model</name>
 	<description>Classes and converters for the Lunatic model</description>
 	<url>https://inseefr.github.io/Lunatic-Model/</url>
@@ -65,6 +66,11 @@
 			<artifactId>eclipselink</artifactId>
 			<version>2.7.13</version>
 		</dependency>
+		<dependency>
+			<groupId>org.glassfish</groupId>
+			<artifactId>javax.json</artifactId>
+			<version>1.1.4</version>
+		</dependency>
 
 		<!-- JSON-P -->
 		<dependency>

src/main/java/fr/insee/lunatic/conversion/XMLSerializer.java

@@ -11,7 +11,7 @@
 import org.slf4j.LoggerFactory;
 
 import fr.insee.lunatic.model.flat.Questionnaire;
-import fr.insee.lunatic.model.flat.SequenceType;
+import fr.insee.lunatic.model.flat.ComponentType;
 
 public class XMLSerializer {
 
@@ -37,19 +37,19 @@ public String serialize(Questionnaire questionnaire) throws JAXBException, Unsup
 
 	}
 
-	public String serialize(SequenceType sequence) throws JAXBException, UnsupportedEncodingException {
+	public String serialize(ComponentType component) throws JAXBException, UnsupportedEncodingException {
 
-		if (sequence == null) return "";
+		if (component == null) return "";
 
-		logger.debug("Serializing sequence " + sequence.getId());
+		logger.debug("Serializing component " + component.getId());
 
-		JAXBContext context = JAXBContext.newInstance(SequenceType.class);
+		JAXBContext context = JAXBContext.newInstance(ComponentType.class);
 		Marshaller marshaller = context.createMarshaller();
 		marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
 		marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
 
 		ByteArrayOutputStream baos = new ByteArrayOutputStream();
-		marshaller.marshal(sequence, baos);
+		marshaller.marshal(component, baos);
 
 		return baos.toString("UTF-8");
 	}

src/main/resources/xsd/LunaticModel.xsd

@@ -9,7 +9,15 @@
     <xs:element name="Questionnaire">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="SequenceType">
+                <xs:extension base="ComponentType">
+                    <xs:sequence>
+						<xs:element name="components" type="ComponentType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="suggesters" type="SuggesterType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="variables" type="IVariableType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="cleaning" type="CleaningType" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="missingBlock" type="MissingType" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="resizing" type="ResizingType" minOccurs="0" maxOccurs="1"/>
+					</xs:sequence>
                     <xs:attribute name="final" type="xs:boolean"/>
                     <xs:attribute name="modele" type="xs:string" use="optional"/>
                     <xs:attribute name="enoCoreVersion" type="xs:string" use="optional"/>
@@ -23,21 +31,6 @@
         </xs:complexType>
     </xs:element>
 
-    <xs:complexType name="SequenceType">
-        <xs:complexContent>
-            <xs:extension base="ComponentType">
-                <xs:sequence>
-                    <xs:element name="components" type="ComponentType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="suggesters" type="SuggesterType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="variables" type="IVariableType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="cleaning" type="CleaningType" minOccurs="0" maxOccurs="1"/>
-                    <xs:element name="missingBlock" type="MissingType" minOccurs="0" maxOccurs="1"/>
-                    <xs:element name="resizing" type="ResizingType" minOccurs="0" maxOccurs="1"/>
-                </xs:sequence>
-            </xs:extension>
-        </xs:complexContent>
-    </xs:complexType>
-
     <xs:complexType name="Sequence">
         <xs:complexContent>
             <xs:extension base="ComponentType">
@@ -184,6 +177,7 @@
             <xs:enumeration value="Dropdown"/>
             <xs:enumeration value="Textarea"/>
             <xs:enumeration value="FilterDescription"/>
+            <xs:enumeration value="Suggester"/>
         </xs:restriction>
     </xs:simpleType>
 
@@ -201,7 +195,7 @@
     		<xs:element name="order" type="SuggesterOrder" minOccurs="0"/>
     		<xs:element name="queryParser" type="SuggesterQueryParser"/>
     		<xs:element name="url" type="xs:string" minOccurs="0"/>
-    		<xs:element name="version" type="xs:string"/>
+    		<xs:element name="version" type="xs:integer"/>
     	</xs:sequence>
     </xs:complexType>
 
@@ -442,6 +436,28 @@
         </xs:complexContent>
     </xs:complexType>
 
+    <xs:complexType name="Suggester">
+        <xs:complexContent>
+            <xs:extension base="ComponentType">
+                <xs:sequence>
+				    <xs:element name="storeName" type="xs:string"/>
+                    <xs:element name="options" type="Options" minOccurs="0" maxOccurs="unbounded"/>
+                    <xs:choice>
+						<xs:element name="response" type="ResponseType"/>
+						<xs:element name="responses" type="SuggesterMultipleResponsesType" maxOccurs="unbounded"/>
+					</xs:choice>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="SuggesterMultipleResponsesType">
+		<xs:sequence>
+			<xs:element name="key" type="xs:string"/>
+			<xs:element name="response" type="ResponseType"/>
+		</xs:sequence>
+	</xs:complexType>
+
     <xs:complexType name="CheckboxGroup">
         <xs:complexContent>
             <xs:extension base="ComponentType">

src/main/resources/xsd/LunaticModelFlat.xsd

@@ -9,7 +9,15 @@
     <xs:element name="Questionnaire">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="SequenceType">
+                <xs:extension base="ComponentType">
+                    <xs:sequence>
+						<xs:element name="components" type="ComponentType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="suggesters" type="SuggesterType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="variables" type="IVariableType" minOccurs="0" maxOccurs="unbounded"/>
+						<xs:element name="cleaning" type="CleaningType" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="missingBlock" type="MissingType" minOccurs="0" maxOccurs="1"/>
+						<xs:element name="resizing" type="ResizingType" minOccurs="0" maxOccurs="1"/>
+					</xs:sequence>
                     <xs:attribute name="final" type="xs:boolean"/>
                     <xs:attribute name="modele" type="xs:string" use="optional"/>
                     <xs:attribute name="enoCoreVersion" type="xs:string" use="optional"/>
@@ -23,21 +31,6 @@
         </xs:complexType>
     </xs:element>
 
-    <xs:complexType name="SequenceType">
-        <xs:complexContent>
-            <xs:extension base="ComponentType">
-                <xs:sequence>
-                    <xs:element name="components" type="ComponentType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="suggesters" type="SuggesterType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="variables" type="IVariableType" minOccurs="0" maxOccurs="unbounded"/>
-                    <xs:element name="cleaning" type="CleaningType" minOccurs="0" maxOccurs="1"/>
-                    <xs:element name="missingBlock" type="MissingType" minOccurs="0" maxOccurs="1"/>
-                    <xs:element name="resizing" type="ResizingType" minOccurs="0" maxOccurs="1"/>
-                </xs:sequence>
-            </xs:extension>
-        </xs:complexContent>
-    </xs:complexType>
-
     <xs:complexType name="Sequence">
         <xs:complexContent>
             <xs:extension base="ComponentType"/>
@@ -96,14 +89,10 @@
             <xs:element name="declarations" type="DeclarationType" minOccurs="0" maxOccurs="unbounded"/>
             <!-- Warning : To validate the name -->
             <xs:element name="conditionFilter" type="ConditionFilterType" minOccurs="0"/>
-
             <xs:element name="controls" type="ControlType" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element name="hierarchy" type="hierarchy" minOccurs="0"/>
             <xs:element name="missingResponse" type="ResponseType" minOccurs="0"/>
-
-			<xs:element name="storeName" type="xs:string" minOccurs="0"/>
-
-            <xs:element name="bindingDependencies" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+			<xs:element name="bindingDependencies" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
         </xs:sequence>
         <xs:attribute name="id" type="xs:ID" use="required"/>
         <xs:attribute name="componentType" type="ComponentTypeEnum"/>
@@ -195,7 +184,7 @@
     		<xs:element name="order" type="SuggesterOrder" minOccurs="0"/>
     		<xs:element name="queryParser" type="SuggesterQueryParser"/>
     		<xs:element name="url" type="xs:string" minOccurs="0"/>
-    		<xs:element name="version" type="xs:string"/>
+    	    <xs:element name="version" type="xs:integer"/>
     	</xs:sequence>
     </xs:complexType>
 
@@ -436,6 +425,28 @@
         </xs:complexContent>
     </xs:complexType>
 
+    <xs:complexType name="Suggester">
+        <xs:complexContent>
+            <xs:extension base="ComponentType">
+                <xs:sequence>
+				    <xs:element name="storeName" type="xs:string"/>
+                    <xs:element name="options" type="Options" minOccurs="0" maxOccurs="unbounded"/>
+                    <xs:choice>
+						<xs:element name="response" type="ResponseType"/>
+						<xs:element name="responses" type="SuggesterMultipleResponsesType" maxOccurs="unbounded"/>
+					</xs:choice>
+                </xs:sequence>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
+    <xs:complexType name="SuggesterMultipleResponsesType">
+		<xs:sequence>
+			<xs:element name="key" type="xs:string"/>
+			<xs:element name="response" type="ResponseType"/>
+		</xs:sequence>
+	</xs:complexType>
+
     <xs:complexType name="CheckboxGroup">
         <xs:complexContent>
             <xs:extension base="ComponentType">

src/test/java/fr/insee/lunatic/conversion/XMLLunaticFlatToJSONLunaticFlatTranslatorTest.java

@@ -0,0 +1,24 @@
+package fr.insee.lunatic.conversion;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class XMLLunaticFlatToJSONLunaticFlatTranslatorTest {
+
+    @Test
+    void convertQuestionnaireWithSuggester_nonNullOutput() throws Exception {
+        // Given (using a xml hierarchical as input and supposing that xml h et xml flat translator works fine)
+        XMLLunaticToXMLLunaticFlatTranslator xmlToXmlFlatTranslator = new XMLLunaticToXMLLunaticFlatTranslator();
+        String xmlFlat = xmlToXmlFlatTranslator.generate(this.getClass().getClassLoader().getResourceAsStream(
+                "conversion/questionnaire-suggester-xml-h.xml"));
+
+        // When
+        XMLLunaticFlatToJSONLunaticFlatTranslator xmlFlatToJsonFlatTranslator = new XMLLunaticFlatToJSONLunaticFlatTranslator();
+        xmlFlatToJsonFlatTranslator.translate(xmlFlat);
+
+        // Then
+        assertNotNull(xmlFlat);
+    }
+
+}

src/test/java/fr/insee/lunatic/conversion/XMLLunaticToJSONLunaticTranslatorTest.java

@@ -0,0 +1,25 @@
+package fr.insee.lunatic.conversion;
+
+import org.junit.jupiter.api.Test;
+
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class XMLLunaticToJSONLunaticTranslatorTest {
+
+    @Test
+    void convertQuestionnaireWithSuggester_nonNullOutput() throws Exception {
+        // Given
+        URL resource = this.getClass().getClassLoader().getResource("conversion/questionnaire-suggester-xml-h.xml");
+        assert resource != null;
+        // When
+        XMLLunaticToJSONLunaticTranslator xmlToJsonFlatTranslator = new XMLLunaticToJSONLunaticTranslator();
+        String result = xmlToJsonFlatTranslator.translate(Files.readString(Path.of(resource.toURI())));
+        // Then
+        assertNotNull(result);
+    }
+
+}

src/test/java/fr/insee/lunatic/conversion/XMLLunaticToXMLLunaticFlatTranslatorTest.java

@@ -0,0 +1,19 @@
+package fr.insee.lunatic.conversion;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class XMLLunaticToXMLLunaticFlatTranslatorTest {
+
+    @Test
+    void convertQuestionnaireWithSuggester_nonNullOutput() throws Exception {
+        // Given + When
+        XMLLunaticToXMLLunaticFlatTranslator xmlToXmlFlatTranslator = new XMLLunaticToXMLLunaticFlatTranslator();
+        String result = xmlToXmlFlatTranslator.generate(this.getClass().getClassLoader().getResourceAsStream(
+                "conversion/questionnaire-suggester-xml-h.xml"));
+        // Then
+        assertNotNull(result);
+    }
+
+}