Skip to content

Commit

Permalink
Preparing for version v0.9.3
Browse files Browse the repository at this point in the history
  • Loading branch information
pkiraly committed Jul 14, 2023
1 parent 198b49d commit 908000f
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 3 deletions.
43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,8 @@ Example: the value should be either "dataverse", "dataset" or "file".

##### `pattern <regular expression>`
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
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<groupId>de.gwdg.metadataqa</groupId>
<artifactId>metadata-qa-api</artifactId>
<packaging>jar</packaging>
<version>0.9.3-SNAPSHOT</version>
<version>0.9.3</version>
<name>Metadata Quality Assurance Framework API</name>
<description>
A metadata quality assurance framework. It checks some metrics of
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/de/gwdg/metadataqa/api/cli/VersionTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 908000f

Please sign in to comment.