Class ExtractCoord

All Implemented Interfaces:
ADQLObject, ADQLOperand

public class ExtractCoord extends GeometryFunction
It represents the COORD1 and the COORD2 functions of the ADQL language.

These functions extract resp. the first and the second coordinate value, in degrees, of a given POINT or column reference.

Example for COORD1:

The right ascension of a point with position (25, -19.5) in degrees would be obtained using the following expression:

COORD1(POINT(25.0, -19.5))

, which would return a numeric value of 25.0 degrees.

And:

COORD1(t.center)

, where t.center is a reference to a column that contains POINT values.

Example for COORD2:

The declination of a point with position (25, -19.5) in degrees, could be obtained using the following expression:

COORD2(POINT(25.0, -19.5))

, which would return a numeric value of -19.5 degrees.

And:

COORD2(t.center)

, where t.center is a reference to a column that contains POINT values.

  • Field Details

    • FEATURE_COORD1

      public static final LanguageFeature FEATURE_COORD1
      Description of this ADQL Feature (COORD1).
      Since:
      2.0
    • FEATURE_COORD2

      public static final LanguageFeature FEATURE_COORD2
      Description of this ADQL Feature (COORD2).
      Since:
      2.0
    • indCoord

      protected final int indCoord
      Number of the coordinate to extract (1 or 2).
    • point

      The point from which the coordinate must be extracted.
  • Constructor Details

  • 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.
    • getName

      public String getName()
      Description copied from interface: ADQLObject
      Gets the name of this object in ADQL.
      Returns:
      The name of this ADQL object.
    • 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.
    • 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 < 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 < 0 || index >= getNbParameters()).
      NullPointerException - If a required parameter must be replaced by a NULL object.
      Exception - If another error occurs.