Komplexní validátor

Nástroj Národní knihovny ČR pro validaci SIP balíčků digitalizovaných dokumentů podle Definic metadatových formátů (DMF) Standardu NDK. Kontroluje strukturu balíčku, soubor info.xml, METS, bibliografická metadata (MODS, DC), technická a administrativní metadata (MIX, PREMIS, copyrightMD), soubory ALTO a OCR TXT a pomocí externích nástrojů i obrazové a zvukové soubory. Výstupem je textový výpis a XML protokol.

Vydání, instalátory a seznamy změn: https://github.com/NLCR/komplexni-validator/releases. Standardy: https://standardy.ndk.cz/. Hlášení chyb a dotazy: GitHub issues.

Každé verzi DMF odpovídá adresář fDMF v validatorConfig/fDMF/ (pravidla, proměnné, vzory názvů, XSD, profily metadat, profily binárních souborů):

Verze DMF se určuje z METS TYPE a z metadataversion v info.xml; parametry --preferred-dmf-<typ>-version a --forced-dmf-<typ>-version (typ mon, per, adg, adf, adi, adn, dad, fdu) ji upřednostní nebo vynutí. Verze ALTO a jejich kontrola: viz ALTO.md. Kontrola registrace URN:NBN se ptá produkčního Resolveru (https://resolver.nkp.cz); parametr --urnnbn-resolver-url ji přepne na jinou instalaci, např. testovací https://resolver-test.nkp.cz. Adresa http:// (lokální testovací instalace bez TLS) je povolená jen s přepínačem --urnnbn-resolver-allow-http; přesměrování z http na https validátor neprovádí, je třeba zadat cílovou adresu.

Vyžaduje JDK 17 pro kompilaci (Gradle toolchain), běh na Javě 17 nebo 21.

./gradlew build                          # sestavení a testy
./gradlew :modules:cliModule:jar         # CLI jar: modules/cliModule/build/libs/cliModule-<verze>.jar
./gradlew :modules:guiModule:run         # spuštění GUI
./gradlew :modules:guiModule:shadowJar   # GUI jar se závislostmi (podklad pro jpackage)

CLI (nápověda --help), příklad validace balíčku s konfigurací z repozitáře a bez externích nástrojů:

java -jar cliModule-<verze>.jar \
    --action VALIDATE_PSP --psp /cesta/k/balicku \
    --config-dir modules/sharedModule/src/main/resources/nkp/pspValidator/shared/validatorConfig \
    --xml-protocol-file protokol.xml \
    --disable-imagemagick --disable-jhove --disable-jpylyzer --disable-kakadu \
    --disable-mp3val --disable-shntool --disable-checkmate

Akce: VALIDATE_PSP, VALIDATE_PSP_GROUP, VALIDATE_METADATA_BY_PROFILE, BUILD_MINIFIED_PACKAGE. Vydaný CLI zip obsahuje jar se všemi závislostmi (KomplexniValidatorCLI.jar) a adresář validatorConfig. Externí nástroje (ImageMagick, JHOVE, Jpylyzer, Kakadu, mp3val, shntool, Checkmate) se zadávají cestou (--<nástroj>-path) nebo vypínají (--disable-<nástroj>); instalátory JHOVE a Jpylyzer jsou v installers/.

Pravidla jsou datová (XML) a jsou popsaná přímo v souborech fDMF: rules.xml (pravidla), variables.xml (proměnné), patterns.xml (vzory názvů souborů), namespaces.xml, adresáře xsd/, biblioProfiles/, techProfiles/, metsProfiles/, binaryFileProfiles/. Dostupné validační a evaluační funkce s parametry jsou vypsané ve validatorConfig/functions/. Atribut validatorVersion konfiguračních souborů musí odpovídat verzi aplikace (Version.java, část před pomlčkou).

Verze aplikace je v gradle.properties (appVersion) a v modules/sharedModule/.../Version.java (VERSION_CODE, BUILD_DATE). Vydání se značí tagem vX.Y a publikuje jako GitHub release; postup vydání, assets a jejich sestavení (tools/release/build-assets.sh): viz release.md.

Apache License 2.0, viz LICENSE.