Package uk.ac.starlink.vo
Enum Class SiaVersion
- All Implemented Interfaces:
Serializable
,Comparable<SiaVersion>
,Constable
Version of the Simple Image Access protocol.
- Since:
- 12 Mar 2020
- Author:
- Mark Taylor
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionabstract uk.ac.starlink.table.StarTable
executeQuery
(String serviceUrl, double ra, double dec, double size, SiaFormatOption format, uk.ac.starlink.table.StarTableFactory factory, uk.ac.starlink.util.ContentCoding coding) Performs an SIA positional query.static SiaVersion
Returns the version object appropriate for use with a given capability interface.Returns the URL of the standards document defining this version.int
Returns the major version number.Returns the StandardsRegExt identifier associated with this version of the SIA standard.toString()
boolean
usesUcd1()
Returns true if query responses use the UCD1 standard, false if they use the UCD1+ standard.static SiaVersion
Returns the enum constant of this class with the specified name.static SiaVersion[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
V10
SIA version 1.0. -
V20
SIA version 2.0.
-
-
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
-
getMajorVersion
public int getMajorVersion()Returns the major version number.- Returns:
- major version number
-
getDocumentUrl
Returns the URL of the standards document defining this version.- Returns:
- document URL
-
getStandardId
Returns the StandardsRegExt identifier associated with this version of the SIA standard.- Returns:
- standardId
-
usesUcd1
public boolean usesUcd1()Returns true if query responses use the UCD1 standard, false if they use the UCD1+ standard.- Returns:
- true for UCD1, false for UCD1+
-
executeQuery
public abstract uk.ac.starlink.table.StarTable executeQuery(String serviceUrl, double ra, double dec, double size, SiaFormatOption format, uk.ac.starlink.table.StarTableFactory factory, uk.ac.starlink.util.ContentCoding coding) throws IOException Performs an SIA positional query. The exact geometry of the query is not defined here, but thesize
parameter defines an angular extent such as the width of a rectangular region or a diameter (not radius) of a cone.- Parameters:
serviceUrl
- base URL for SIA service query resourcera
- central right ascension position in degreesdec
- central declination position in degreessize
- extent of query in degreesformat
- required format for query result records returnedfactory
- table factorycoding
- content coding for communications- Returns:
- table giving query result
- Throws:
IOException
-
toString
- Overrides:
toString
in classEnum<SiaVersion>
-
forInterface
Returns the version object appropriate for use with a given capability interface.- Parameters:
intf
- interface- Returns:
- SIA version used by interface; not null, a best guess is used if necessary
-