feat: add ATC codes and related service

7 files changed, 502 insertions, 0 deletions

diff --git a/src/main/java/dev/dnpm/oshelper/atc/AgentCode.java b/src/main/java/dev/dnpm/oshelper/atc/AgentCode.java
new file mode 100644
index 0000000..7320431
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/AgentCode.java
@@ -0,0 +1,41 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc;
+
+/**
+ * Common Agent Code definition
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+public interface AgentCode extends Comparable<AgentCode> {
+    String getCode();
+
+    String getName();
+
+    CodeSystem getSystem();
+
+    String getVersion();
+}
diff --git a/src/main/java/dev/dnpm/oshelper/atc/AtcCode.java b/src/main/java/dev/dnpm/oshelper/atc/AtcCode.java
new file mode 100644
index 0000000..9f33f6b
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/AtcCode.java
@@ -0,0 +1,100 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc;
+
+import java.util.Objects;
+
+/**
+ * ATC-Code as used in WHO XML file
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+public class AtcCode implements AgentCode {
+
+    private final String code;
+    private final String name;
+
+    private final String version;
+
+    public AtcCode(String code, String name) {
+        this.code = code;
+        this.name = name;
+        this.version = null;
+    }
+
+    public AtcCode(String code, String name, String version) {
+        this.code = code;
+        this.name = name;
+        this.version = version;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public CodeSystem getSystem() {
+        return CodeSystem.ATC;
+    }
+
+    public String getVersion() {
+        return version;
+    }
+
+    @Override
+    public int compareTo(final AgentCode agentCode) {
+        return this.name.toLowerCase().compareTo(agentCode.getName().toLowerCase());
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AgentCode otherAgentCode = (AgentCode) o;
+        return Objects.equals(code.toLowerCase(), otherAgentCode.getCode().toLowerCase())
+                && Objects.equals(name.toLowerCase(), otherAgentCode.getName().toLowerCase())
+                && Objects.equals(version, otherAgentCode.getVersion());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(code.toLowerCase(), name.toLowerCase());
+    }
+
+    /**
+     * Checks for usable ATC code starting at level 2
+     * @param code Code to be checked
+     * @return Will return <code>true</code> if code matches ATC code scheme
+     */
+    public static boolean isAtcCode(String code) {
+        return null != code
+                && ! code.isBlank()
+                && code.matches("[ABCDGHJLMNPRSV][0-2][1-9]([A-Z]([A-Z](\\d{2})?)?)?");
+    }
+}
diff --git a/src/main/java/dev/dnpm/oshelper/atc/CodeSystem.java b/src/main/java/dev/dnpm/oshelper/atc/CodeSystem.java
new file mode 100644
index 0000000..6e76ff9
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/CodeSystem.java
@@ -0,0 +1,36 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc;
+
+/**
+ * This enum provides usable coding systems
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+public enum CodeSystem {
+    ATC,
+    UNREGISTERED
+}
\ No newline at end of file
diff --git a/src/main/java/dev/dnpm/oshelper/atc/UnregisteredCode.java b/src/main/java/dev/dnpm/oshelper/atc/UnregisteredCode.java
new file mode 100644
index 0000000..d5efdde
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/UnregisteredCode.java
@@ -0,0 +1,80 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc;
+
+import java.util.Objects;
+
+/**
+ * Unregistered code as used in Onkostar database
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+public class UnregisteredCode implements AgentCode {
+
+    private final String code;
+    private final String name;
+
+    public UnregisteredCode(String code, String name) {
+        this.code = code;
+        this.name = name;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public CodeSystem getSystem() {
+        return CodeSystem.UNREGISTERED;
+    }
+
+    public String getVersion() {
+        return null;
+    }
+
+    @Override
+    public int compareTo(final AgentCode agentCode) {
+        return this.name.toLowerCase().compareTo(agentCode.getName().toLowerCase());
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AgentCode otherAgentCode = (AgentCode) o;
+        return Objects.equals(code.toLowerCase(), otherAgentCode.getCode().toLowerCase())
+                && Objects.equals(name.toLowerCase(), otherAgentCode.getName().toLowerCase())
+                && Objects.equals(this.getVersion(), otherAgentCode.getVersion());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(code.toLowerCase(), name.toLowerCase());
+    }
+}
diff --git a/src/main/java/dev/dnpm/oshelper/atc/services/AgentCodeService.java b/src/main/java/dev/dnpm/oshelper/atc/services/AgentCodeService.java
new file mode 100644
index 0000000..5d215a7
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/services/AgentCodeService.java
@@ -0,0 +1,49 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc.services;
+
+
+import dev.dnpm.oshelper.atc.AgentCode;
+
+import java.util.List;
+
+/**
+ * Common interface for agent code services
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+public interface AgentCodeService {
+
+    /**
+     * Queries source for agents with name and code starting with query string.
+     * If size is zero, all available results will be returned.
+     *
+     * @param query The query string
+     * @param size  Maximal amount of responses
+     * @return A list with agent codes
+     */
+    List<AgentCode> findAgentCodes(String query, int size);
+}
diff --git a/src/main/java/dev/dnpm/oshelper/atc/services/CsvAgentCodeService.java b/src/main/java/dev/dnpm/oshelper/atc/services/CsvAgentCodeService.java
new file mode 100644
index 0000000..9c02a3c
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/services/CsvAgentCodeService.java
@@ -0,0 +1,111 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc.services;
+
+import dev.dnpm.oshelper.atc.AgentCode;
+import dev.dnpm.oshelper.atc.AtcCode;
+import dev.dnpm.oshelper.exceptions.FileParsingException;
+import org.apache.commons.csv.CSVFormat;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+/**
+ * Service to query for agent codes based on ATC codes file
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+@Service
+public class CsvAgentCodeService implements AgentCodeService {
+
+    protected final Logger logger = LoggerFactory.getLogger(this.getClass());
+    protected final List<AgentCode> codeList = new ArrayList<>();
+
+    private static final String ATC_CODE_COLUMN = "ATC-Codes";
+    private static final String ATC_NAME_COLUMN = "ATC-Bedeutung";
+    private static final String ATC_VERSION_COLUMN = "Version";
+
+    public CsvAgentCodeService() {
+        this.codeList.addAll(parseFile());
+    }
+
+    /**
+     * Queries source for agents code starting with or name containing query string.
+     * If size is zero, all available results will be returned.
+     *
+     * @param query The query string
+     * @param size  Maximal amount of responses
+     * @return A list with agent codes
+     */
+    @Override
+    public List<AgentCode> findAgentCodes(final String query, final int size) {
+        var resultStream = this.codeList.stream().filter(agentCode ->
+                agentCode.getCode().toLowerCase().startsWith(query.toLowerCase())
+                        || agentCode.getName().toLowerCase().contains(query.toLowerCase())
+        );
+
+        if (size > 0) {
+            return resultStream.limit(size).collect(Collectors.toList());
+        }
+        return resultStream.collect(Collectors.toList());
+    }
+
+    protected List<AgentCode> parseFile() {
+        var result = new ArrayList<AgentCode>();
+
+        try {
+            var inputStream = Objects.requireNonNull(this.getClass().getClassLoader().getResourceAsStream("atc.csv"));
+            var parser = CSVFormat.RFC4180
+                    .withHeader()
+                    .withDelimiter('\t')
+                    .withIgnoreEmptyLines()
+                    .withSkipHeaderRecord()
+                    .parse(new InputStreamReader(inputStream));
+            for (var row : parser) {
+                if (!row.isMapped(ATC_CODE_COLUMN) || !row.isMapped(ATC_NAME_COLUMN)) {
+                    throw new FileParsingException("No CSV column for ATC code or name found");
+                }
+                if (row.isMapped(ATC_VERSION_COLUMN)) {
+                    result.add(new AtcCode(row.get(ATC_CODE_COLUMN).trim(), row.get(ATC_NAME_COLUMN), row.get(ATC_VERSION_COLUMN)));
+                } else {
+                    result.add(new AtcCode(row.get(ATC_CODE_COLUMN).trim(), row.get(ATC_NAME_COLUMN)));
+                }
+            }
+            return result;
+        } catch (IOException | FileParsingException e) {
+            logger.warn("Error reading information from ATC codes");
+        }
+        return result;
+    }
+
+}
diff --git a/src/main/java/dev/dnpm/oshelper/atc/services/OnkostarAgentCodeService.java b/src/main/java/dev/dnpm/oshelper/atc/services/OnkostarAgentCodeService.java
new file mode 100644
index 0000000..62f12b7
--- /dev/null
+++ b/src/main/java/dev/dnpm/oshelper/atc/services/OnkostarAgentCodeService.java
@@ -0,0 +1,85 @@
+/*
+ * This file is part of onkostar-plugin-dnpm
+ *
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.dnpm.oshelper.atc.services;
+
+import dev.dnpm.oshelper.atc.AgentCode;
+import dev.dnpm.oshelper.atc.AtcCode;
+import dev.dnpm.oshelper.atc.UnregisteredCode;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.stereotype.Service;
+
+import javax.sql.DataSource;
+import java.util.List;
+
+/**
+ * Implementation of {@link AgentCodeService} that uses database to query for unregistered agents
+ *
+ * @author Paul-Christian Volkmer
+ * @since 2.0.0
+ */
+@Service
+public class OnkostarAgentCodeService implements AgentCodeService {
+
+    private final JdbcTemplate jdbcTemplate;
+
+    public OnkostarAgentCodeService(final DataSource dataSource) {
+        this.jdbcTemplate = new JdbcTemplate(dataSource);
+    }
+
+    /**
+     * Queries source for agents code starting with or name containing query string.
+     * If size is zero, all available results will be returned.
+     *
+     * @param query The query string
+     * @param size  Maximal amount of responses
+     * @return A list with agent codes
+     */
+    @Override
+    public List<AgentCode> findAgentCodes(final String query, final int size) {
+        var sql = "SELECT code, shortdesc\n" +
+                "    FROM property_catalogue\n" +
+                "    JOIN property_catalogue_version ON (property_catalogue_version.datacatalog_id = property_catalogue.id)\n" +
+                "    JOIN property_catalogue_version_entry p ON (p.property_version_id = property_catalogue_version.id)\n" +
+                "    WHERE name = 'OS.Substanzen'\n" +
+                "    AND (LOWER(code) LIKE ? OR LOWER(shortdesc) LIKE ? OR LOWER(synonyms) LIKE ?)";
+
+        if (size > 0) {
+            sql = sql + " LIMIT " + size;
+        }
+
+        return jdbcTemplate.query(
+                sql,
+                new Object[]{query + "%", "%" + query + "%", "%" + query + "%"},
+                (resultSet, i) -> {
+                    var code = resultSet.getString("code");
+                    var shortdesc = resultSet.getString("shortdesc");
+                    if (AtcCode.isAtcCode(code)) {
+                        return new AtcCode(code, shortdesc);
+                    }
+                    return new UnregisteredCode(code, shortdesc);
+                }
+        );
+    }
+}