Class ExtractCoordSys

All Implemented Interfaces:
ADQLObject, ADQLOperand

public class ExtractCoordSys extends GeometryFunction
It represents the COORDSYS function the ADQL language.

This function returns the formal name of the coordinate system for a given geometry as a string.

Example:

The following example would return the coordinate system of a POINT literal:

COORDSYS(POINT(25.0, -19.5))

, which would return a string value representing the coordinate system used to create the POINT.

The COORDSYS function may be applied to any expression that returns a geometric datatype.

Example:

COORDSYS(t.footprint)

, where t.footprint is a reference to a database column that contains geometric (POINT, BOX, CIRCLE, POLYGON or REGION) values.

From version 2.1, this function has been marked as deprecated. It may be removed in future versions of this specification (> 2.1). Details of the coordinate system for a database column are available as part of the service metadata, available via the TAP_SCHEMA tables defined in the TAP specification and the /tables web-service response defined in the VOSI specification.

  • Field Details

  • Constructor Details

    • ExtractCoordSys

      public ExtractCoordSys(GeometryFunction.GeometryValue<GeometryFunction> param)
      Builds a COORDSYS function.
      Parameters:
      param - The geometry from which the coordinate system string must be extracted.
    • ExtractCoordSys

      public ExtractCoordSys(ExtractCoordSys toCopy) throws Exception
      Builds a COORDSYS function by copying the given one.
      Parameters:
      toCopy - The COORDSYS function to copy.
      Throws:
      Exception - If there is an error during the copy.
  • Method Details

    • getFeatureDescription

      public final LanguageFeature getFeatureDescription()
      Description copied from interface: ADQLObject
      Get the description of this ADQL's Language Feature.

      Note: Getting this description is generally only useful when discovery optional features so that determining if they are allowed to be used in ADQL queries.

      Returns:
      Description of this ADQL object as an ADQL's feature.
    • getCopy

      public ADQLObject getCopy() throws Exception
      Description copied from interface: ADQLObject
      Gets a (deep) copy of this ADQL object.
      Returns:
      The copy of this ADQL object.
      Throws:
      Exception - If there is any error during the copy.
    • getName

      public String getName()
      Description copied from interface: ADQLObject
      Gets the name of this object in ADQL.
      Returns:
      The name of this ADQL object.
    • isNumeric

      public boolean isNumeric()
      Description copied from interface: ADQLOperand
      Tell whether this operand is numeric or not.
      Returns:
      true if this operand is numeric, false otherwise.
    • isString

      public boolean isString()
      Description copied from interface: ADQLOperand
      Tell whether this operand is a string or not.
      Returns:
      true if this operand is a string, false otherwise.
    • isGeometry

      public boolean isGeometry()
      Description copied from interface: ADQLOperand
      Tell whether this operand is a geometrical region or not.
      Returns:
      true if this operand is a geometry, false otherwise.
    • getParameters

      public ADQLOperand[] getParameters()
      Description copied from class: ADQLFunction
      Gets the list of all parameters of this function.
      Specified by:
      getParameters in class ADQLFunction
      Returns:
      Its parameters list.
    • getNbParameters

      public int getNbParameters()
      Description copied from class: ADQLFunction
      Gets the number of parameters this function has.
      Specified by:
      getNbParameters in class ADQLFunction
      Returns:
      Number of parameters.
    • getParameter

      public ADQLOperand getParameter(int index) throws ArrayIndexOutOfBoundsException
      Description copied from class: ADQLFunction
      Gets the index-th parameter.
      Specified by:
      getParameter in class ADQLFunction
      Parameters:
      index - Parameter number.
      Returns:
      The corresponding parameter.
      Throws:
      ArrayIndexOutOfBoundsException - If the index is incorrect (index invalid input: '<' 0 || index >= getNbParameters()).
    • setParameter

      public ADQLOperand setParameter(int index, ADQLOperand replacer) throws ArrayIndexOutOfBoundsException, NullPointerException, Exception
      Description copied from class: ADQLFunction
      Replaces the index-th parameter by the given one.
      Specified by:
      setParameter in class ADQLFunction
      Parameters:
      index - Index of the parameter to replace.
      replacer - The replacer.
      Returns:
      The replaced parameter.
      Throws:
      ArrayIndexOutOfBoundsException - If the index is incorrect (index invalid input: '<' 0 || index >= getNbParameters()).
      NullPointerException - If a required parameter must be replaced by a NULL object.
      Exception - If another error occurs.