cessda.cmv.core

CESSDA Metadata Validator core. Contains business logic of all use cases.

https://github.com/cessda/cessda.cmv.core

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.0%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

CESSDA Metadata Validator core. Contains business logic of all use cases.

Basic Info
  • Host: GitHub
  • Owner: cessda
  • License: apache-2.0
  • Language: Java
  • Default Branch: main
  • Homepage:
  • Size: 23.3 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 8
  • Releases: 5
Created about 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

CESSDA Metadata Validator Core

SQAaaS badge

SQAaaS badge shields.io

Build Status Quality Gate Status Coverage Code Smells Technical Debt Security Rating Vulnerabilities Bugs

This repository holds all core domain logic about CESSDA Metadata Validator project.

Prerequisites

The following SDKs must be installed before the project can be used.

  • Java Development Kit (JDK) 8 (or later)

Usage

This is a short snippet showing how to use the validator.

java void validateUsingFiles() { CessdaMetadataValidatorFactory factory = new CessdaMetadataValidatorFactory(); Document document = factory.newDocument( new File( "path/to/ddi-document.xml" ) ); Profile profile = factory.newProfile( new File( "path/to/ddi-profile.xml" ) ); ValidationReport validationReport = factory.validate( document, profile, BASIC ); boolean isValid = validationReport.getConstraintViolations().isEmpty(); validationReport.getConstraintViolations().forEach( cv -> System.out.println( cv.getMessage() ) ); }

For more detailed information, consult the JavaDoc.

Logging

Logging is provided using SLF4J. Applications integrating CMV Core must provide their own SLF4J implementation (such as Logback) for logs to be outputted.

Dependency Information

Add CESSDA Maven Repository to your pom.xml:

xml <repositories> <repository> <id>cessda-nexus</id> <url>https://nexus.cessda.eu/repository/maven-releases</url> </repository> </repositories>

For snapshots add:

xml <repositories> <repository> <id>cessda-nexus-snapshots</id> <url>https://nexus.cessda.eu/repository/maven-snapshots</url> </repository> </repositories>

Add the dependency to your pom.xml:

xml <dependency> <groupId>eu.cessda.cmv</groupId> <artifactId>cmv-core</artifactId> <version>1.0.0</version> </dependency>

Getting started as developer

```shell

Pull repository and change directory

git clone https://github.com/cessda/cessda.cmv.core.git cd cessda.cmv.core

Execute tests

./mvnw clean test ```

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

See Semantic Versioning for guidance.

Changes

You can find the list of changes made in each release in the CHANGELOG file.

License

See the LICENSE file.

Citing

See the CITATION file.

Owner

  • Name: CESSDA
  • Login: cessda
  • Kind: organization
  • Location: Norway

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CESSDA Metadata Validator - Core component
message: N/A
type: software
authors:
  - given-names: Jeannine
    family-names: Beeken
    email: jeannine.beeken@essex.ac.uk
    affiliation: UK Data Archive
  - given-names: Darren
    family-names: Bell
    email: dbell@essex.ac.uk
    affiliation: UK Data Archive
  - given-names: Sharon
    family-names: Bolton
    email: sharonb@essex.ac.uk
    affiliation: UK Data Archive
  - given-names: Kerrin
    family-names: Borschewski
    email: kerrin.borschewski@gesis.org
    affiliation: GESIS
  - given-names: Taina
    family-names: Jääskeläinen
    email: taina.jaaskelainen@tuni.fi
    affiliation: FSD
  - given-names: Katja
    family-names: Moilanen
    email: katja.moilanen@tuni.fi
    affiliation: FSD
  - given-names: Matthew
    family-names: Morris
    email: matthew.morris@cessda.eu
    affiliation: CESSDA ERIC
  - given-names: Alexander
    family-names: Mühlbauer
    email: alexander.muehlbauer@gesis.org
    affiliation: GESIS
  - given-names: Wolfgang
    family-names: Zenk-Möltgen
    email: wolfgang.zenk-moeltgen@gesis.org
    affiliation: GESIS

GitHub Events

Total
  • Issues event: 2
  • Delete event: 30
  • Issue comment event: 1
  • Push event: 37
  • Pull request review event: 36
  • Pull request event: 66
  • Create event: 34
Last Year
  • Issues event: 2
  • Delete event: 30
  • Issue comment event: 1
  • Push event: 37
  • Pull request review event: 36
  • Pull request event: 66
  • Create event: 34

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 2
  • Total pull requests: 28
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 27
Past Year
  • Issues: 2
  • Pull requests: 28
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 27
Top Authors
Issue Authors
  • borsna (1)
  • cessda-bitbucket-importer (1)
  • matthew-morris-cessda (1)
Pull Request Authors
  • dependabot[bot] (83)
  • matthew-morris-cessda (5)
  • Joshocan (1)
Top Labels
Issue Labels
bug (1) use case (1) major (1)
Pull Request Labels
dependencies (83) java (16) minor (2) enhancement (2)

Dependencies

pom.xml maven
  • com.fasterxml.jackson:jackson-bom 2.14.1 import
  • com.fasterxml.jackson.core:jackson-databind
  • com.jayway.jsonpath:json-path 2.7.0
  • io.swagger.core.v3:swagger-annotations 2.2.8
  • javax.validation:validation-api 2.0.1.Final
  • org.gesis.commons:commons-resource 0.8.0
  • org.gesis.commons:commons-xml 5.7.0
  • org.mockito:mockito-core 4.11.0
  • com.fasterxml.jackson.dataformat:jackson-dataformat-xml test
  • com.fasterxml.jackson.module:jackson-module-jaxb-annotations test
  • com.tngtech.archunit:archunit 0.22.0 test
  • org.gesis.commons:commons-test 0.12.0 test