Package adql.db.region
Enum Class CoordSys.RefPos
- All Implemented Interfaces:
Serializable
,Comparable<CoordSys.RefPos>
,Constable
- Enclosing class:
CoordSys
List of all possible reference positions in an STC expression.
When no value is specified, the default one is UNKNOWNREFPOS
.
The default value is also accessible through the attribute
DEFAULT
and it is possible to test whether a reference position
is the default with the function isDefault()
.
Note: The possible values listed in this enumeration are limited to the subset of STC-S described by the section "6 Use of STC-S in TAP (informative)" of the TAP Recommendation 1.0 (27th March 2010).
- Since:
- 1.3
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CoordSys.RefPos
Default value for a reference position:UNKNOWNREFPOS
.static final String
Regular expression to test whether a string is a valid reference position or not. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Tell whether this reference position is the default one.static CoordSys.RefPos
Returns the enum constant of this class with the specified name.static CoordSys.RefPos[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
BARYCENTER
-
GEOCENTER
-
HELIOCENTER
-
LSR
-
TOPOCENTER
-
RELOCATABLE
-
UNKNOWNREFPOS
-
-
Field Details
-
DEFAULT
Default value for a reference position:UNKNOWNREFPOS
. -
regexp
Regular expression to test whether a string is a valid reference position or not. This regular expression does not take into account the case of an empty string (which means "default reference position").
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
isDefault
public final boolean isDefault()Tell whether this reference position is the default one.- Returns:
true
if this is the default reference position,false
otherwise.
-