tap.metadata

Class TAPCoosys

java.lang.Object

tap.metadata.TAPCoosys

public class TAPCoosys
extends java.lang.Object

Definition of a coordinate system.

This object just annotates a TAPColumn object (see TAPColumn.getCoosys() and TAPColumn.setCoosys(TAPCoosys)). Its only purpose is to enrich the VOTable metadata so that VO clients (like Aladin and TOPCAT) can use the coordinates the most precisely as possible.

Since:

2.1

Version:

2.1 (07/2017)

Author:

Grégory Mantelet (ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	epoch Epoch at which the coordinates were measured.
protected java.lang.String	equinox Equinox of this coordinate system.
protected java.lang.String	id ID of this coordinate system definition.
protected java.lang.String	system Name of the coordinate system.

Constructor Summary

Constructors

Constructor and Description
TAPCoosys(java.lang.String id, java.lang.String system) Create a minimum coordinate system definition.
TAPCoosys(java.lang.String id, java.lang.String system, java.lang.String equinox, java.lang.String epoch) Create a coordinate system definition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEpoch() Get the epoch at which the coordinates were measured.
java.lang.String	getEquinox() Get the equinox of this coordinate system.
java.lang.String	getId() Get the ID of this coordinate system definition.
java.lang.String	getSystem() Get the coordinate system of this definition.
int	hashCode()
void	setEpoch(java.lang.String epoch) Set the epoch at which the coordinates were measured.
void	setEquinox(java.lang.String equinox) Set the equinox of this coordinate system.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected final java.lang.String id

ID of this coordinate system definition.

It is particularly used in the VOTable to associate columns with it.

Note: This attribute can NOT be NULL.

system

protected final java.lang.String system

Name of the coordinate system.

It should be a value among: "ICRS", "eq FK5", "eq FK4", "ecl FK4", "ecl FK5", "galactic", "supergalactic", "barycentric", "geo app" and a user-defined "xy" value.

equinox

protected java.lang.String equinox

Equinox of this coordinate system.

This parameter required to fix the equatorial or ecliptic systems (as e.g. "J2000" as the default "eq FK5" or "B1950" as the default "eq FK4").

epoch

protected java.lang.String epoch

Epoch at which the coordinates were measured.

Constructor Detail

TAPCoosys

public TAPCoosys(java.lang.String id,
                 java.lang.String system)
          throws java.lang.NullPointerException

Create a minimum coordinate system definition.

Parameters:

id - ID of the definition to create. (must NOT be NULL)

system - Coordinate system. (must NOT be NULL)

Throws:

java.lang.NullPointerException - If any of the given parameters is NULL or an empty string.

TAPCoosys

public TAPCoosys(java.lang.String id,
                 java.lang.String system,
                 java.lang.String equinox,
                 java.lang.String epoch)
          throws java.lang.NullPointerException

Create a coordinate system definition.

Only the ID and the system are required. The equinox and especially the epoch are optional.

Parameters:

id - ID of the definition to create. (must NOT be NULL)

system - Coordinate system. (must NOT be NULL)

equinox - Equinox of this coordinate system.

epoch - Epoch at which the coordinates were measured.

Throws:

java.lang.NullPointerException - If the ID or the system is NULL or an empty string.

Method Detail

getId

public final java.lang.String getId()

Get the ID of this coordinate system definition.

Returns:

Its ID. (can NOT be NULL)

getSystem

public final java.lang.String getSystem()

Get the coordinate system of this definition.

Returns:

Its system. (can NOT be NULL)

getEquinox

public final java.lang.String getEquinox()

Get the equinox of this coordinate system.

Returns:

Its equinox. (may be NULL)

setEquinox

public void setEquinox(java.lang.String equinox)

Set the equinox of this coordinate system.

Parameters:

equinox - Its new equinox. (may be NULL)

getEpoch

public final java.lang.String getEpoch()

Get the epoch at which the coordinates were measured.

Returns:

Its equinox. (may be NULL)

setEpoch

public void setEpoch(java.lang.String epoch)

Set the epoch at which the coordinates were measured.

Parameters:

epoch - Its new epoch. (may be NULL)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object