Package uk.ac.starlink.table
Class UCD
- java.lang.Object
-
- uk.ac.starlink.table.UCD
-
- All Implemented Interfaces:
java.lang.Comparable
public class UCD extends java.lang.Object implements java.lang.Comparable
Describes Uniform Column Descriptors. This class knows about all currently defined UCDs, the Unified Column Descriptors defined by the CDS. Each UCD has a unique ID by which it is known, and a description giving a brief explanation of what it means.UCDs are obtained from the static
getUCD(java.lang.String)
method; any two UCDs with the same ID are guaranteed to be the same object.Source of information
The UCD ids and descriptions are read from a list at the resourceUCD_DEFINITIONS_LOC
. If this resource is unavailable at runtime, a warning will be written to the logging system. The original source of this text file was the CDS List of all UCDs.- Author:
- Mark Taylor (Starlink)
- See Also:
- Unified Content Descriptors
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
UCD_DEFINITIONS_LOC
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.Object other)
Implements theComparable
interface, comparing alphabetically by ID.java.lang.String
getDescription()
Returns the textual description of the UCD.java.lang.String
getID()
Returns the ID string of this UCD.static UCD
getUCD(java.lang.String id)
Returns the UCD object corresponding to a given UCD ID string.static java.util.Iterator
getUCDs()
Returns an iterator over all the known UCDs.java.lang.String
toString()
Returns the UCD id string.
-
-
-
Field Detail
-
UCD_DEFINITIONS_LOC
public static final java.lang.String UCD_DEFINITIONS_LOC
- See Also:
- Constant Field Values
-
-
Method Detail
-
getID
public java.lang.String getID()
Returns the ID string of this UCD.- Returns:
- the ID string (capitals, underscores and numbers only)
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the UCD.- Returns:
- a few words describing the meaning of this UCD
-
compareTo
public int compareTo(java.lang.Object other)
Implements theComparable
interface, comparing alphabetically by ID.- Specified by:
compareTo
in interfacejava.lang.Comparable
-
getUCD
public static UCD getUCD(java.lang.String id)
Returns the UCD object corresponding to a given UCD ID string. Returns null if no UCD with the given name is known.- Parameters:
id
- the string used to identify the UCD (it will have surrounding spaces trimmed)- Returns:
- the UCD object corresponding to id, or null if none can be found
-
getUCDs
public static java.util.Iterator getUCDs()
Returns an iterator over all the known UCDs. The iterator returns the UCDs in their natural order (alphabetic by ID).- Returns:
- an Iterator which iterates over all the existing UCD objects
-
toString
public java.lang.String toString()
Returns the UCD id string.- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of this UCD
-
-