Class PointFunction

All Implemented Interfaces:
ADQLObject, ADQLOperand

public class PointFunction extends GeometryFunction
It represents the POINT function of the ADQL language.

This function expresses a single location on the sky, and it corresponds semantically to the equivalent term, SpatialCoord, defined in the STC specification.

The function arguments specify the position, where:

  • the position is given by a pair of numeric coordinates in degrees
  • the numeric coordinates MUST be within the ranges resp. [0,360] and [-90,90].

Example:

A function expressing a point with right ascension of 25 degrees and declination of -19.5 degrees would be written as follows:

POINT(25.0, -19.5)

, where numeric values are in degrees.

The coordinates for POINT may be literal values, as above, or they may be column references, functions or expressions that return numeric values.

Example:

POINT(t.ra, t.dec)

, where t.ra and t.dec are references to database columns that contain numeric values.

For historical reasons, the POINT function accepts an optional string value as the first argument. As of this version of the specification (2.1) this parameter has been marked as deprecated. Future versions of this specification (> 2.1) may remove this parameter.

  • Field Details

    • FEATURE

      public static final LanguageFeature FEATURE
      Description of this ADQL Feature.
      Since:
      2.0
  • 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.
    • getCoord1

      public final ADQLOperand getCoord1()
      Gets the first coordinate of this point.
      Returns:
      Its first coordinate.
    • setCoord1

      public void setCoord1(ADQLOperand coord1) throws NullPointerException, Exception
      Changes the first coordinate of this POINT function.
      Parameters:
      coord1 - Its new first coordinate.
      Throws:
      NullPointerException - If the given operand is null.
      Exception - If the given operand is not numeric.
    • getCoord2

      public final ADQLOperand getCoord2()
      Gets the second coordinate of this point.
      Returns:
      Its second coordinate.
    • setCoord2

      public void setCoord2(ADQLOperand coord2) throws NullPointerException, Exception
      Changes the second coordinate of this POINT function.
      Parameters:
      coord2 - Its new second coordinate.
      Throws:
      NullPointerException - If the given operand is null.
      Exception - If the given operand is not numeric.
    • 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 < 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.