diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e537e9..df70503 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,48 @@ # Metadata Quality Assessment Framework API Changelog +## v0.9.3 (2023-07-14) + +Important API change: +- in `pattern` the tool use find() instead of matches(), so one should not specify a complex pattern from the beginning to the end + +The release contains dependency updates. + +The artefacts of the release are available in Maven Central as well: https://central.sonatype.dev/artifact/de.gwdg.metadataqa/metadata-qa-api/0.9.3 + +## v0.9.2 (2023-06-09) + +- Set AND, NOT, OR NA if the data is NA. + +## v0.9.1 (2023-05-16) + +- rename PathCache to Selector +- adding constants for using in QA catalogue +- update dependencies and adapt code to the API changes + +## v0.9.0 (2022-11-21) + +This release contains the results of two important developments adding a command line interface created by +Miel Vander Sande (@mielvds) and applying the framework on the data of Deutsche Digitale Bibliothek. These two +developments made the tool more robust, and more flexible so became applicable to different situations. + +To use the command line interface, download mqa and metadata-qa-api-0.9.0-shaded.jar, and follow the suggestions of the README.md file. + +new rules: +- unique: checks if the value of the field is unique +- dependencies: checks if other rules has already checked and passed +- dimension: checks if a linked image fits to some dimension constraints (unit in pixel) +- hidden: if the rule is hidden it will be calculated, but its output will not be present in the overall output +- skip: prevents a particular rule to be part of calculation +- debug: log the rule ID, value and result + +The schema is called MQA Schema. Some instances are available in the metadata-qa-ddb repository: https://github.com/pkiraly/metadata-qa-ddb/tree/main/src/main/resources + +Important API changes: +- the JsonBranch class has been renamed to DataElement +- the OaiPmhXPath class has been renamed to XPathWrapper + +The artefacts of the release are available in Maven Central as well: https://central.sonatype.dev/artifact/de.gwdg.metadataqa/metadata-qa-api/0.9.0 + ## v0.8 (2022-03-16) - improve the rule checking mechanisms: adding IDs, minWords and maxWords checkers, content type checker, optimizing OR checker and range rules, successScore and failureScore diff --git a/README.md b/README.md index c6b6658..62c782e 100644 --- a/README.md +++ b/README.md @@ -649,7 +649,8 @@ Example: the value should be either "dataverse", "dataset" or "file". ##### `pattern ` A regular expression that each field value matches to satisfy the condition. -The expression should cover the whole string, not only a part of it +The expression can match a a part of the whole string (see the Java Matcher +object's [find](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#find--) method). (API: `setPattern(String)` or `withPattern(String)`) Example: the field value should start with http:// or https:// and end with diff --git a/pom.xml b/pom.xml index 612ad32..96c5e14 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ de.gwdg.metadataqa metadata-qa-api jar - 0.9.3-SNAPSHOT + 0.9.3 Metadata Quality Assurance Framework API A metadata quality assurance framework. It checks some metrics of diff --git a/src/test/java/de/gwdg/metadataqa/api/cli/VersionTest.java b/src/test/java/de/gwdg/metadataqa/api/cli/VersionTest.java index c7f3e71..ebf0b01 100644 --- a/src/test/java/de/gwdg/metadataqa/api/cli/VersionTest.java +++ b/src/test/java/de/gwdg/metadataqa/api/cli/VersionTest.java @@ -6,7 +6,7 @@ public class VersionTest { - private final String EXPECTED_VERSION = "0.9.3-SNAPSHOT"; + private final String EXPECTED_VERSION = "0.9.3"; ; @Test