Package uk.ac.starlink.vo
Class UcdStatus
- java.lang.Object
-
- uk.ac.starlink.vo.UcdStatus
-
public class UcdStatus extends java.lang.Object
Categorises UCD validity. ThegetStatus(java.lang.String)
method tests a UCD string to determine whether it conforms to standards, and returns an object that reports this. UCD1+ and UCD1 are recognised.Gregory Mantelet's Ucidy library is used for UCD1+ parsing.
- Since:
- 9 Jul 2021
- Author:
- Mark Taylor
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UcdStatus.Code
Characterises UCD standards conformance.
-
Constructor Summary
Constructors Modifier Constructor Description protected
UcdStatus(UcdStatus.Code code, java.lang.String message)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UcdStatus.Code
getCode()
Returns a status element indicating conformance.java.lang.String
getMessage()
Returns a human-readable message supplying additional information.static UCDParser
getParser()
Returns the UCD parser used by this class.static UcdStatus
getStatus(java.lang.String ucd)
Returns the status for a given UCD string.
-
-
-
Constructor Detail
-
UcdStatus
protected UcdStatus(UcdStatus.Code code, java.lang.String message)
Constructor.- Parameters:
code
- status codemessage
- human-readable message supplying additional information
-
-
Method Detail
-
getCode
public UcdStatus.Code getCode()
Returns a status element indicating conformance.- Returns:
- code
-
getMessage
public java.lang.String getMessage()
Returns a human-readable message supplying additional information. The returned text does not in general report the original UCD string.- Returns:
- message, or null if nothing to say (OK status)
-
getStatus
public static UcdStatus getStatus(java.lang.String ucd)
Returns the status for a given UCD string.- Parameters:
ucd
- UCD text- Returns:
- status, or null for blank input
-
getParser
public static UCDParser getParser()
Returns the UCD parser used by this class.- Returns:
- parser
-
-