uk.ac.starlink.ttools.func

Class VO

java.lang.Object

uk.ac.starlink.ttools.func.VO

public class VO
extends Object

Virtual Observatory-specific functions. Some of these are for rather technical purposes.

The UCD parsing functions are based on Grégory Mantelet's library Ucidy corresponding to UCD1+ 1.5, and the VOUnit parsing functions are based on Norman Gray's library Unity corresponding to VOUnits 1.0.

TFCat refers to the Time-Frequency Radio Catalogues format, TFCat 1.0.

Since:

8 Jul 2021

Author:

Mark Taylor

Method Summary

Modifier and Type	Method and Description
static String	tfcatMessage(String tfcat) Returns a human-readable message associated with the parsing of a TFCat text.
static String	tfcatStatus(String tfcat) Returns a token string giving the category of TFCat compliance.
static String	ucdMessage(String ucd) Returns a human-readable message associated with the parsing of a UCD.
static String	ucdStatus(String ucd) Returns a token string giving the category of UCD compliance.
static String	vounitMessage(String unit) Returns a human-readable message associated with the parsing of a unit string.
static String	vounitStatus(String unit) Returns a token string giving the category of VOUnits compliance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ucdStatus

public static String ucdStatus(String ucd)

Returns a token string giving the category of UCD compliance. UCD1+, UCD1 and SIAv1 ("VOX:")-style UCDs are recognised.

Possible return values are currently:

• "OK": conforms to UCD1+ standard
• "UCD1": looks like a UCD1
• "VOX": is in VOX: namespace introduced by SIAv1
• "BAD_SYNTAX": not a UCD1 and cannot be parsed according to UCD1+
• "BAD_SEQUENCE": UCD words violate UCD1+ sequence rules
• "UNKNOWN_WORD": follows UCD1+ syntax rules but contains non-UCD1+ atom
• "NAMESPACE": follows UCD1+ syntax but contains atoms in non-standard namespace
• "DEPRECATED": contains deprecated UCD1+ words

In the case of non-compliant values, more information can be found using the ucdMessage function.

Parameters:

ucd - UCD string

Returns:

"OK" for conformant UCD1+, otherwise some other value

ucdMessage

public static String ucdMessage(String ucd)

Returns a human-readable message associated with the parsing of a UCD. This is expected to be empty for a fully compliant UCD, and may contain error messages or advice otherwise.

Parameters:

ucd - UCD value

Returns:

message text

vounitStatus

public static String vounitStatus(String unit)

Returns a token string giving the category of VOUnits compliance.

Possible return values are currently:

• "OK": conforms to VOUnits syntax
• "UNKNOWN_UNIT": parsed as VOUnit but contains unknown base unit(s)
• "GUESSED_UNIT": parsed as VOUnit but contains unknown, though guessable, base unit(s)
• "BAD_SYNTAX": cannot be parsed as VOUnit syntax
• "PARSE_ERROR": unexpected error during parsing
• "USAGE": violates VOUnit usage constraints
• "WHITESPACE": legal VOUnit except that it contains whitespace, which is not allowed by VOUnits

In the case of non-compliant values, more information can be found using the vounitMessage function.

Parameters:

unit - unit string

Returns:

"OK" for conformant VOUnits, otherwise some other value

vounitMessage

public static String vounitMessage(String unit)

Returns a human-readable message associated with the parsing of a unit string. This is expected to be empty for a string fully compliant with VOUnits, and may contain error messages or additional information otherwise.

Parameters:

unit - unit string

Returns:

message text

tfcatStatus

public static String tfcatStatus(String tfcat)

Returns a token string giving the category of TFCat compliance.

Possible return values are currently:

• "OK": conforms to TFCat syntax
• "ERROR": parsed as TFCat, but with one or more errors
• "FAIL": could not be parsed as a TFCat object

For non-OK values, more information can be found using the tfcatMessage function.

Parameters:

tfcat - JSON string giving TFCat text

Returns:

"OK" for conformant TFCat, otherwise some other value

tfcatMessage

public static String tfcatMessage(String tfcat)

Returns a human-readable message associated with the parsing of a TFCat text. This will be empty for a string fully compliant with the TFCat standard, but will contain error messages otherwise.

Parameters:

tfcat - JSON string giving TFCat text

Returns:

message text