adql.db

Enum STCS.RefPos

java.lang.Object

java.lang.Enum<STCS.RefPos>

adql.db.STCS.RefPos

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<STCS.RefPos>

Enclosing class:

STCS

public static enum STCS.RefPos
extends java.lang.Enum<STCS.RefPos>

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

Version:

1.3 (10/2014)

Author:

Grégory Mantelet (ARI)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BARYCENTER
GEOCENTER
HELIOCENTER
LSR
RELOCATABLE
TOPOCENTER
UNKNOWNREFPOS

Field Summary

Fields

Modifier and Type	Field and Description
static STCS.RefPos	DEFAULT Default value for a reference position: UNKNOWNREFPOS.
static java.lang.String	regexp Regular expression to test whether a string is a valid reference position or not.

Method Summary

Modifier and Type	Method and Description
boolean	isDefault() Tell whether this reference position is the default one.
static STCS.RefPos	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static STCS.RefPos[]	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

BARYCENTER

public static final STCS.RefPos BARYCENTER

GEOCENTER

public static final STCS.RefPos GEOCENTER

HELIOCENTER

public static final STCS.RefPos HELIOCENTER

LSR

public static final STCS.RefPos LSR

TOPOCENTER

public static final STCS.RefPos TOPOCENTER

RELOCATABLE

public static final STCS.RefPos RELOCATABLE

UNKNOWNREFPOS

public static final STCS.RefPos UNKNOWNREFPOS

Field Detail

DEFAULT

public static final STCS.RefPos DEFAULT

Default value for a reference position: UNKNOWNREFPOS.

regexp

public static final java.lang.String 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 Detail

values

public static STCS.RefPos[] 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 (STCS.RefPos c : STCS.RefPos.values())
    System.out.println(c);

Returns:

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

valueOf

public static STCS.RefPos 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

isDefault

public final boolean isDefault()

Tell whether this reference position is the default one.

Returns:

true if this is the default reference position, false