Introduce serialization modules to the library

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java: [ '11' ]
+        java: [ '17' ]
         os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest' ]
     steps:
       - name: Checkout code

.github/workflows/release.yml

@@ -46,7 +46,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java: [ '11' ]
+        java: [ '17' ]
         os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest' ]
     steps:
       - name: Checkout code
@@ -110,7 +110,7 @@ jobs:
       - name: Setup java
         uses: actions/setup-java@v2
         with:
-          java-version: 11
+          java-version: 17
           distribution: 'temurin'
       - name: Publish jars
         run: ./gradlew publish

build.gradle

@@ -9,8 +9,8 @@ subprojects {
         showViolations = true
     }
 
-    sourceCompatibility = 11
-    targetCompatibility = 11
+    sourceCompatibility = 17
+    targetCompatibility = 17
 
     ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
 

gradle.properties

@@ -2,8 +2,25 @@ group=com.epam.jsdmx
 version=1.0.0-SNAPSHOT
 
 #dependencies
+jupiter_version=5.8.2
 lombok_version=1.18.24
 org_apache_commons_commons_collections4_version=4.4
-org_apache_commons_commons_lang3_version=3.12.0
-jupiter_version=5.8.2
-assertj_version=3.22.0
+org_apache_commons_commons_lang3_version=3.18.0
+jupiter_api_version=5.11.4
+jupiter_engine_version=5.11.4
+mockito_version=5.4.0
+json_unit_version=4.1.1
+spring_version=6.2.10
+log4j_version=2.24.3
+sdmx_version=2.0.6
+mapstruct_version=1.5.3.Final
+fasterxml_version=2.18.4
+fasterxml_databind_version=2.18.4
+guava_version=33.0.0-jre
+openc_csv_version=5.12.0
+random_beans_version=3.9.0
+jsonschema2pojo_version=1.2.2
+junit_version=4.13.2
+assertj_version=3.26.3
+xmlunit_legacy_version=2.10.3
+xml_bind_jaxb_version=3.0.2

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

lib/sdmx-json10/build.gradle

@@ -0,0 +1,49 @@
+plugins {
+    id 'java'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation project(":lib:sdmx30-serializer")
+    implementation project(":lib:sdmx30-infomodel")
+
+    compileOnly("org.projectlombok:lombok:${lombok_version}")
+    annotationProcessor("org.projectlombok:lombok:${lombok_version}")
+
+    implementation("org.apache.logging.log4j:log4j-slf4j2-impl:${log4j_version}")
+    implementation("org.apache.logging.log4j:log4j-core:${log4j_version}")
+    implementation("com.epam.deltix:SdmxDataParser:${sdmx_version}")
+
+    implementation("org.apache.commons:commons-collections4:${org_apache_commons_commons_collections4_version}")
+    implementation("org.apache.commons:commons-lang3:${org_apache_commons_commons_lang3_version}")
+    implementation("com.fasterxml.jackson.core:jackson-core:${fasterxml_version}")
+    implementation("com.fasterxml.jackson.core:jackson-databind:${fasterxml_databind_version}")
+    implementation("com.google.guava:guava:${guava_version}")
+
+    testImplementation("org.projectlombok:lombok:${lombok_version}")
+    testAnnotationProcessor("org.projectlombok:lombok:${lombok_version}")
+
+    testImplementation("org.jsonschema2pojo:jsonschema2pojo-core:${jsonschema2pojo_version}")
+    testImplementation("io.github.benas:random-beans:${random_beans_version}")
+    testImplementation("org.assertj:assertj-core:${assertj_version}")
+    testImplementation("net.javacrumbs.json-unit:json-unit:${json_unit_version}")
+    testImplementation("net.javacrumbs.json-unit:json-unit-assertj:${json_unit_version}")
+    testImplementation("org.mockito:mockito-core:${mockito_version}")
+
+    testImplementation("com.epam.deltix:SdmxApi:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxBeans:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxDataParser:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxFileQueryProcessor:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxQueryBuilder:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxSourceUtil:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxStructureParser:${sdmx_version}")
+    testImplementation("com.epam.deltix:SdmxStructureRetrieval:${sdmx_version}")
+    testImplementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.15.3'
+}
+
+test {
+    useJUnitPlatform()
+}

lib/sdmx-json10/src/main/java/com/epam/jsdmx/json10/structure/writer/AgencySchemeWriter.java

@@ -0,0 +1,42 @@
+package com.epam.jsdmx.json10.structure.writer;
+
+
+import java.io.IOException;
+import java.util.Set;
+
+import com.epam.jsdmx.infomodel.sdmx30.AgencyScheme;
+import com.epam.jsdmx.infomodel.sdmx30.AgencySchemeImpl;
+import com.epam.jsdmx.infomodel.sdmx30.Artefacts;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+
+public class AgencySchemeWriter extends MaintainableWriter<AgencyScheme> {
+
+    private final OrganisationWriter organisationWriter;
+
+    public AgencySchemeWriter(VersionableWriter versionableWriter,
+                              LinksWriter linksWriter,
+                              OrganisationWriter organisationWriter) {
+        super(versionableWriter, linksWriter);
+        this.organisationWriter = organisationWriter;
+    }
+
+    @Override
+    protected void writeFields(JsonGenerator jsonGenerator, AgencyScheme artefact) throws IOException {
+        AgencySchemeImpl agencyScheme = (AgencySchemeImpl) artefact;
+        agencyScheme.setId(StructureUtils.AGENCIES_ID);
+        super.writeFields(jsonGenerator, agencyScheme);
+        jsonGenerator.writeBooleanField(StructureUtils.IS_PARTIAL, agencyScheme.isPartial());
+        organisationWriter.writeOrganisation(jsonGenerator, artefact.getItems(), StructureUtils.AGENCIES);
+    }
+
+    @Override
+    protected Set<AgencyScheme> extractArtefacts(Artefacts artefacts) {
+        return artefacts.getAgencySchemes();
+    }
+
+    @Override
+    protected String getArrayName() {
+        return StructureUtils.AGENCY_SCHEMES;
+    }
+}

lib/sdmx-json10/src/main/java/com/epam/jsdmx/json10/structure/writer/AnnotableWriter.java

@@ -0,0 +1,44 @@
+package com.epam.jsdmx.json10.structure.writer;
+
+import java.io.IOException;
+import java.util.List;
+
+import com.epam.jsdmx.infomodel.sdmx30.AnnotableArtefact;
+import com.epam.jsdmx.infomodel.sdmx30.Annotation;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.collections4.CollectionUtils;
+
+@RequiredArgsConstructor
+public class AnnotableWriter {
+
+    private final LinksWriter linksWriter;
+
+    public <T extends AnnotableArtefact> void write(JsonGenerator jsonGenerator, T annotableArtefact) throws IOException {
+        write(jsonGenerator, annotableArtefact.getAnnotations());
+    }
+
+    protected void write(JsonGenerator jsonGenerator, List<Annotation> annotations) throws IOException {
+        if (CollectionUtils.isEmpty(annotations)) {
+            return;
+        }
+        jsonGenerator.writeFieldName(StructureUtils.ANNOTATIONS);
+        jsonGenerator.writeStartArray();
+        for (Annotation annotation : annotations) {
+            writeAnnotation(jsonGenerator, annotation);
+        }
+        jsonGenerator.writeEndArray();
+    }
+
+    private void writeAnnotation(JsonGenerator jg, Annotation annotation) throws IOException {
+        jg.writeStartObject();
+        StructureUtils.writeStringField(jg, StructureUtils.ID, annotation.getId());
+        StructureUtils.writeStringField(jg, StructureUtils.TITLE, annotation.getTitle());
+        StructureUtils.writeStringField(jg, StructureUtils.TYPE, annotation.getType());
+        StructureUtils.writeStringField(jg, StructureUtils.TEXT, (annotation.getText() != null) ? annotation.getText().getForDefaultLocale() : null);
+        StructureUtils.writeInternationalString(jg, annotation.getText(), StructureUtils.TEXTS);
+        linksWriter.writeLinks(jg, annotation.getUrl());
+        jg.writeEndObject();
+    }
+}

lib/sdmx-json10/src/main/java/com/epam/jsdmx/json10/structure/writer/AttributeListWriter.java

@@ -0,0 +1,111 @@
+package com.epam.jsdmx.json10.structure.writer;
+
+import static com.epam.jsdmx.json10.structure.writer.StructureUtils.writeStringField;
+
+import java.io.IOException;
+import java.util.List;
+
+import com.epam.jsdmx.infomodel.sdmx30.AttributeDescriptor;
+import com.epam.jsdmx.infomodel.sdmx30.AttributeDescriptorImpl;
+import com.epam.jsdmx.infomodel.sdmx30.AttributeRelationship;
+import com.epam.jsdmx.infomodel.sdmx30.DataAttribute;
+import com.epam.jsdmx.infomodel.sdmx30.DimensionRelationship;
+import com.epam.jsdmx.infomodel.sdmx30.GroupRelationship;
+import com.epam.jsdmx.infomodel.sdmx30.ObservationRelationship;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import lombok.EqualsAndHashCode;
+import org.apache.commons.collections4.CollectionUtils;
+
+@EqualsAndHashCode(callSuper = false)
+public class AttributeListWriter {
+
+    private final IdentifiableWriter identifiableWriter;
+    private final ConceptRoleWriter conceptRoleWriter;
+    private final ComponentWriter componentWriter;
+
+    public AttributeListWriter(IdentifiableWriter identifiableWriter,
+                               ConceptRoleWriter conceptRoleWriter,
+                               ComponentWriter componentWriter) {
+        this.identifiableWriter = identifiableWriter;
+        this.conceptRoleWriter = conceptRoleWriter;
+        this.componentWriter = componentWriter;
+    }
+
+    public void write(JsonGenerator jsonGenerator, AttributeDescriptor attributeDescriptor) throws IOException {
+        jsonGenerator.writeFieldName(StructureUtils.ATTRIBUTE_LIST);
+        if (attributeDescriptor == null || attributeDescriptor.getComponents().isEmpty()) {
+            jsonGenerator.writeNull();
+            return;
+        }
+
+        AttributeDescriptorImpl attributeDescriptorImpl = (AttributeDescriptorImpl) attributeDescriptor;
+        attributeDescriptorImpl.setId(StructureUtils.ATTRIBUTE_DESCRIPTOR_ID);
+
+        jsonGenerator.writeStartObject();
+        identifiableWriter.write(jsonGenerator, attributeDescriptorImpl);
+
+        writeDataAttributes(jsonGenerator, attributeDescriptorImpl.getComponents());
+
+        jsonGenerator.writeEndObject();
+    }
+
+    private void writeDataAttributes(JsonGenerator jsonGenerator, List<DataAttribute> attributeDescriptorComponents) throws IOException {
+        jsonGenerator.writeFieldName(StructureUtils.ATTRIBUTES);
+        jsonGenerator.writeStartArray();
+        if (attributeDescriptorComponents != null && !attributeDescriptorComponents.isEmpty()) {
+            for (DataAttribute dataAttribute : attributeDescriptorComponents) {
+                if (dataAttribute != null) {
+                    jsonGenerator.writeStartObject();
+                    componentWriter.write(jsonGenerator, dataAttribute);
+                    writeAssignmentStatus(jsonGenerator, dataAttribute.isMandatory());
+                    conceptRoleWriter.write(jsonGenerator, dataAttribute.getConceptRoles());
+                    writeAttributeRelationship(jsonGenerator, dataAttribute.getAttributeRelationship());
+                    jsonGenerator.writeEndObject();
+                }
+            }
+        }
+        jsonGenerator.writeEndArray();
+    }
+
+    private void writeAssignmentStatus(JsonGenerator jg, boolean mandatory) {
+        writeStringField(jg, "assignmentStatus", mandatory ? "Mandatory" : "Conditional");
+    }
+
+    private void writeAttributeRelationship(JsonGenerator jg, AttributeRelationship attributeRelationship) throws IOException {
+        jg.writeFieldName(StructureUtils.ATTRIBUTE_RELATIONSHIP);
+        jg.writeStartObject();
+        if (attributeRelationship instanceof DimensionRelationship) {
+            DimensionRelationship dimensionRelationship = (DimensionRelationship) attributeRelationship;
+            jg.writeFieldName(StructureUtils.DIMENSIONS);
+            List<String> dimensions = dimensionRelationship.getDimensions();
+            jg.writeStartArray();
+            for (String dimension : dimensions) {
+                jg.writeString(dimension);
+            }
+            jg.writeEndArray();
+
+            List<String> groupKeys = dimensionRelationship.getGroupKeys();
+            if (CollectionUtils.isNotEmpty(groupKeys)) {
+                jg.writeFieldName(StructureUtils.ATTACHMENT_GROUPS);
+                jg.writeStartArray();
+                for (String groupKey : groupKeys) {
+                    jg.writeString(groupKey);
+                }
+                jg.writeEndArray();
+            }
+
+        } else if (attributeRelationship instanceof ObservationRelationship) {
+            writeStringField(jg, "primaryMeasure", "OBS_VALUE");
+        } else if (attributeRelationship instanceof GroupRelationship) {
+            GroupRelationship groupRelationship = (GroupRelationship) attributeRelationship;
+            jg.writeStringField(StructureUtils.GROUP, groupRelationship.getGroupKey());
+        } else {
+            jg.writeFieldName(StructureUtils.NONE);
+            jg.writeStartObject();
+            jg.writeEndObject();
+        }
+        jg.writeEndObject();
+    }
+
+}

lib/sdmx-json10/src/main/java/com/epam/jsdmx/json10/structure/writer/BaseWriterJson.java

@@ -0,0 +1,20 @@
+package com.epam.jsdmx.json10.structure.writer;
+
+import java.io.OutputStream;
+
+import com.fasterxml.jackson.core.JsonEncoding;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.SneakyThrows;
+
+public class BaseWriterJson {
+
+    protected final JsonGenerator jsonGenerator;
+
+    @SneakyThrows
+    protected BaseWriterJson(ObjectMapper mapper,
+                             OutputStream outputStream) {
+        this.jsonGenerator = mapper.getFactory().createGenerator(outputStream, JsonEncoding.UTF8);
+    }
+
+}