ari.ucidy

Enum UCDSyntax

java.lang.Object

java.lang.Enum<UCDSyntax>

ari.ucidy.UCDSyntax

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UCDSyntax>

public enum UCDSyntax
extends java.lang.Enum<UCDSyntax>

All possible syntax rules as defined by the IVOA Recommendation 2018-05-27 for the UCD1+ controlled vocabulary v1.3: http://www.ivoa.net/documents/UCD1+/20180527/index.html

Version:

1.1 (06/2018)

Author:

Grégory Mantelet (CDS)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH The word can be used indifferently as first or secondary word.
COLOUR A colour index ; can be followed by two successive word describing a part of the electromagnetic spectrum.
PHOT_QUANTITY A photometric quantity ; can be followed by a word describing a part of the electromagnetic spectrum.
PRIMARY The word can only be used as “primary” or first word.
SECONDARY The word cannot be used as the first word to describe a single quantity.
VECTOR A vector.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	allowedSyntaxCodes Human readable list of all possible syntaxes (in their character form) listed in this Enum class.
protected char	syntaxCode Character associated with this UCD syntax.

Method Summary

Modifier and Type	Method and Description
static UCDSyntax	get(char syntaxCode) Get the Enum item representing the given syntax code character.
static UCDSyntax	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UCDSyntax[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOTH

public static final UCDSyntax BOTH

The word can be used indifferently as first or secondary word.

COLOUR

public static final UCDSyntax COLOUR

A colour index ; can be followed by two successive word describing a part of the electromagnetic spectrum.

Implementation note: It will be considered as BOTH in term of order (i.e. its place in the UCD is not important).

PHOT_QUANTITY

public static final UCDSyntax PHOT_QUANTITY

A photometric quantity ; can be followed by a word describing a part of the electromagnetic spectrum.

Implementation note: It will be considered as BOTH in term of order (i.e. its place in the UCD is not important).

PRIMARY

public static final UCDSyntax PRIMARY

The word can only be used as “primary” or first word.

SECONDARY

public static final UCDSyntax SECONDARY

The word cannot be used as the first word to describe a single quantity.

VECTOR

public static final UCDSyntax VECTOR

A vector. Such a word can be followed by another describing the axis or reference frame in which the measurement is done.

Implementation note: It will be considered as BOTH in term of order (i.e. its place in the UCD is not important).

Field Detail

allowedSyntaxCodes

public static final java.lang.String allowedSyntaxCodes

Human readable list of all possible syntaxes (in their character form) listed in this Enum class.

syntaxCode

protected final char syntaxCode

Character associated with this UCD syntax.

Note: the case of the character (i.e. lower or upper case) should not be important.

Method Detail

get

public static UCDSyntax get(char syntaxCode)

Get the Enum item representing the given syntax code character.

Parameters:

syntaxCode - The syntax code character for which the corresponding Enum item is asked.

Returns:

The corresponding Enum item, or null if none matches.

valueOf

public static UCDSyntax valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static UCDSyntax[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UCDSyntax c : UCDSyntax.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared