uk.ac.ebi.ddi:ddi-validator

Parent pom DDI project

License

License

GroupId

GroupId

uk.ac.ebi.ddi
ArtifactId

ArtifactId

ddi-validator
Last Version

Last Version

1.2
Release Date

Release Date

Type

Type

jar
Description

Description

Parent pom DDI project
Project URL

Project URL

https://github.com/OmicsDI/xml-validator
Source Code Management

Source Code Management

https://github.com/OmicsDI/xml-validator.git

Download ddi-validator

How to add to project

<!-- https://jarcasting.com/artifacts/uk.ac.ebi.ddi/ddi-validator/ -->
<dependency>
    <groupId>uk.ac.ebi.ddi</groupId>
    <artifactId>ddi-validator</artifactId>
    <version>1.2</version>
</dependency>
// https://jarcasting.com/artifacts/uk.ac.ebi.ddi/ddi-validator/
implementation 'uk.ac.ebi.ddi:ddi-validator:1.2'
// https://jarcasting.com/artifacts/uk.ac.ebi.ddi/ddi-validator/
implementation ("uk.ac.ebi.ddi:ddi-validator:1.2")
'uk.ac.ebi.ddi:ddi-validator:jar:1.2'
<dependency org="uk.ac.ebi.ddi" name="ddi-validator" rev="1.2">
  <artifact name="ddi-validator" type="jar" />
</dependency>
@Grapes(
@Grab(group='uk.ac.ebi.ddi', module='ddi-validator', version='1.2')
)
libraryDependencies += "uk.ac.ebi.ddi" % "ddi-validator" % "1.2"
[uk.ac.ebi.ddi/ddi-validator "1.2"]

Dependencies

compile (8)

Group / Artifact Type Version
psidev.psi.tools » xxindex jar 0.11
uk.ac.ebi.ddi : ddi-domain-db jar 1.0
ch.qos.logback : logback-core jar 1.0.7
ch.qos.logback : logback-classic jar 1.0.7
it.unimi.dsi : fastutil jar 6.5.1
org.codehaus.woodstox : woodstox-core-asl jar 4.4.1
commons-cli : commons-cli jar 1.2
com.sun.xml.bind : jaxb-xjc jar 2.2.7

provided (1)

Group / Artifact Type Version
org.slf4j : slf4j-api jar 1.6.4

test (1)

Group / Artifact Type Version
junit : junit jar 4.10

Project Modules

There are no modules declared in this project.

xml-validator


Build Status

The xml validator provide a way of validating the XML files for the BD2K-DDI project. The current library and corresponding commandline tool provides different options for checking the quality of the files and the metadata they provide. The library is based on the rules and specifications for the OmicsDI project. The schema validation will provide a first validation of the file using the OmicsDI schema; the validation can be done for a directory or per files. Some of the validation steps, each entry in the file must contain this properties:

  • id
  • name
  • publication (dates)
  • omics_type
  • repository
  • full_dataset_link

For a full list of properties and rules, please visit the current specification OmicsDI.

How to use the tool

The main commandline tool validatorCLI can be download from the releases pages release, after unzip the tool it can be called as:

>  java -jar validatorCLI.jar --help
usage: validatorCLI
 -check <arg>              Choose validation level (default level is
                           Warn):
                           Warn: This category do a complete Schema and
                           semantic validation of the file
                           Error: This category do a validation at level
                           of XML Schema
 -h,--help                 print help message
 -inFile <arg>             Input file or Directory fo ve processed. If the
                           value is a directory, the procedure will be
                           applied to all files
 -merge <property=value>   Convert a given directory files to an out put
                           with other options
 -reportFile <arg>         Record error/warn messages into outfile. If not
                           set, print message on the screen.

If the user is interested to validate the file at the schema level (not semantic validation):

>  java -jar validatorCLI.jar -inFile PRIDE-XML.xml -check Error

The latest command will produce a file with the extension PRIDE-XML.xml.output.csv with all the errors if the file have errors. If the user is interested to do semantic validation of the file, the command should be refined to:

>  java -jar validatorCLI.jar -inFile PRIDE-XML.xml -check Warn

Support

For any issue or support questions, please contact [email protected]

uk.ac.ebi.ddi

Versions

Version
1.2
1.1
1.0