Version 0.9.4

This release contains changes needed for the Aqinda project.

Important changes:

• Adding serialization of Schema objects to JSON
• Implement BaseSchema.merge(BaseSchema) #175
• Count rule violations per fields #172
• Add score for NAs #158
• The schema's namespace definition is not picked up #157
• Handling redirection 302 #97
• Update README

Code quality related updates:

• Implement SonarCloud quality suggestions #159
• Update Github Action versions

Dependency updates:

• com.fasterxml.jackson.core:jackson-databind from 2.15.2 to 2.16.1
• com.jayway.jsonpath:json-path from 2.8.0 to 2.9.0
• com.opencsv:opencsv from 5.7.1 to 5.9
• commons-cli:commons-cli from 1.5.0 to 1.6.0
• commons-io:commons-io from 2.13.0 to 2.15.1
• net.minidev:json-smart from 2.4.11 to 2.5.0
• org.apache.commons:commons-lang3 from 3.12.0 to 3.14.0
• org.apache.commons:commons-text from 1.10.0 to 1.11.0
• org.apache.solr:solr-solrj from 9.2.1 to 9.4.1
• org.slf4j:slf4j-api from 2.0.10 to 2.0.12
• org.slf4j:slf4j-api from 2.0.7 to 2.0.10
• org.slf4j:slf4j-simple from 2.0.10 to 2.0.12
• org.slf4j:slf4j-simple from 2.0.7 to 2.0.10
• org.yaml:snakeyaml from 2.0 to 2.2

The artefacts of the release are available in Maven Central as well: https://central.sonatype.com/artifact/de.gwdg.metadataqa/metadata-qa-api/0.9.4

Files:

• metadata-qa-api-0.9.4.jar: contains only the classes of the Metadata Quality Assessment Framework
• metadata-qa-api-0.9.4-shaded.jar: contains the classes of the Metadata Quality Assessment Framework and all dependencies (useful in standalone usage)
• mqa: the command line interface

Release v0.9.3

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.com/artifact/de.gwdg.metadataqa/metadata-qa-api/0.9.3

Files:

• metadata-qa-api-0.9.3.jar: contains only the classes of the Metadata Quality Assessment Framework
• metadata-qa-api-0.9.3-shaded.jar: contains the classes of the Metadata Quality Assessment Framework and all dependencies (useful in standalone usage)
• mqa: the command line interface

Release v0.9.1

This release contains only small changes:

• update dependencies and adapt code to the API changes
• rename PathCache to Selector
• adding constants for using in QA catalogue

Release v0.9.0

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

Release v0.8.1

• improve the rule checking mechanisms: adding IDs, minWords and maxWords checkers, content type checker, optimizing OR checker and range rules, successScore and
  failureScore
• improve rule output
• new schema parameters: indexField, unique, inactive
• new measurement configuration parameters: onlyIdInHeader, indexer, AnnotationCalculator
• field extractor is independent from recordId and is enabled only if there are extractable fields in the schema
• improve documentation: a section about quality diemnsions
• improving XML namespace handling.
• better CSV support
• changing to Java 11
• internal refactoring and decoupling of classes
• adding several tools to developer workflow: sonarcloud.io, coveralls, codecov, GitHub action

Release v0.8

• improve the rule checking mechanisms: adding IDs, minWords and maxWords checkers, content type checker, optimizing OR checker and range rules, successScore and
  failureScore
• improve rule output
• new schema parameters: indexField, unique, inactive
• new measurement configuration parameters: onlyIdInHeader, indexer, AnnotationCalculator
• field extractor is independent from recordId and is enabled only if there are extractable fields in the schema
• improve documentation: a section about quality diemnsions
• improving XML namespace handling.
• better CSV support
• changing to Java 11
• internal refactoring and decoupling of classes
• adding several tools to developer workflow: sonarcloud.io, coveralls, codecov, GitHub action

Release v0.7

The new features in this release are

• configuration
• content rules (constraints)

Check the README.md for the details and examples.

You can use the tool via downloading .jar files or you can add it into the project from Maven repository, such as

<dependency>
  <groupId>de.gwdg.metadataqa</groupId>
  <artifactId>metadata-qa-api</artifactId>
  <version>0.7</version>
</dependency>