This GitHub repository contains the sources of a library aiming to validate any UCD (Unified Content Descriptor). This current version aims to respect as much as possible the definition provided by the IVOA standard: An IVOA Standard for Unified Content Descriptors - Version 1.10. The parser is by default configured with the list of all validated UCD words listed in The UCD1+ controlled vocabulary 1.6.
- Check whether each UCD word is:
- syntactically valid
- recognised (i.e. the word is among a list of well known UCD words)
- recommended by the IVOA (The UCD1+ controlled vocabulary 1.6)
- Possibility to customise the list of known UCD words (by default all validated UCD1+ are automatically loaded)
- Validate a full UCD with
- a list of human-readable errors
- an automatic correction suggestion (particularly for typo)
- a list of advice to improve the readability of the UCD
- Detection of deprecated UCD words (when detected a clear error message is returned and a correction suggestion is proposed)
- Different ways to search UCD words
- exact match
- starting with
- closest match (take into account possible typo)
- Support namespace prefix
This library is developed using Java 1.8 (should be compatible with Java 1.8 or newer).
The compiled JAR, the runnable JAR, the sources and the Javadoc API are available on GitHub for all releases and especially for the latest one.
This library is under the conditions of the LPGL-v3. See COPYING.LESSER and COPYING for more details.
I strongly encourage you to declare any issue you encounter here. Thus, anybody who has the same problem can see whether his/her problem is already known. If the problem is known the progress and/or comments about its resolution will be published.
In addition, if you have forked this repository and made some corrections on your side which are likely to interest any other user of the libraries, please, send a pull request here. Provided these modifications are in accordance with the IVOA definition and do not relate specifically to your use case, they will be integrated (maybe after some modifications) in this repository and thus will be made available to everybody.
Both the management of dependencies and compilation are possible thanks to
Gradle. However, to compile or to run tests, no need to install Gradle. Just
use the gradlew (or gradlew.bat on Windows).
To generate the JAR file:
./gradlew jarThe JAR file will be available in the directory lib/build/libs/.
To run all tests:
./gradlew testTests results will be available in the directory lib/build/test-results/.
No dependency.
The directory lib/src/main/resources/ contains two files for the moment:
ucd1p-words.txt. It lists all official IVOA UCD1+ words as provided at https://www.ivoa.net/documents/UCDlist/20241218/ucd-list.txt.ucd1p-deprecated.txt. This is a list of all deprecated UCD1+ words as provided at https://www.ivoa.net/documents/UCDlist/20241218/ucd-list-deprecated.txt.
These files are loaded by the default parser initialised in the class UCDParser.
If the file ucd1p-words.txt is renamed or removed, the default parser will
raise a warning on the standard error output and will be initialized with an
empty list of known UCD1+ words. Consequently, any UCD parsed using this parser
will be systematically flagged as not recognised and so not recommended.
The sources of these three libraries come with some JUnit test files. You can
find them in the directory lib/src/main/test/java/.