Class CircleFunction

  • All Implemented Interfaces:
    ADQLObject, ADQLOperand

    public class CircleFunction
    extends GeometryFunction

    It represents the CIRCLE function of the ADQL language.

    This function expresses a circular region on the sky (a cone in space) and corresponds semantically to the STC circle region. The function arguments specify the coordinate system, the center position, and the radius (in degrees).

    Example:
    CIRCLE('ICRS GEOCENTER', 25.4, -20.0, 1)
    In this example the function expresses a circle of one degree radius centered in a position of (25.4, -20.0) degrees and defined according to the ICRS coordinate system with GEOCENTER reference position.

    Version:
    1.4 (06/2015)
    Author:
    Grégory Mantelet (CDS;ARI)
    • Constructor Detail

      • CircleFunction

        public CircleFunction​(ADQLOperand coordinateSystem,
                              ADQLOperand firstCoord,
                              ADQLOperand secondCoord,
                              ADQLOperand radius)
                       throws java.lang.NullPointerException,
                              java.lang.Exception
        Builds a CIRCLE function.
        Parameters:
        coordinateSystem - The coordinate system in which the center position is expressed.
        firstCoord - The first coordinate of the center position.
        secondCoord - The second coordinate of the center position.
        radius - The radius of the circle (in degrees).
        Throws:
        java.lang.NullPointerException - If at least one parameter is incorrect or if the coordinate system is unknown.
        java.lang.Exception - If there is another error.
      • CircleFunction

        public CircleFunction​(CircleFunction toCopy)
                       throws java.lang.Exception
        Builds a CIRCLE function by copying the given one.
        Parameters:
        toCopy - The CIRCLE function to copy.
        Throws:
        java.lang.Exception - If there is an error during the copy.
    • Method Detail

      • getCopy

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

        public java.lang.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.
      • getCoord1

        public final ADQLOperand getCoord1()
        Gets the first coordinate of the center (i.e. right ascension).
        Returns:
        The first coordinate.
      • setCoord1

        public final void setCoord1​(ADQLOperand coord1)
        Sets the first coordinate of the center (i.e. right ascension).
        Parameters:
        coord1 - The first coordinate.
      • getCoord2

        public final ADQLOperand getCoord2()
        Gets the second coordinate of the center (i.e. declination).
        Returns:
        The second coordinate.
      • setCoord2

        public final void setCoord2​(ADQLOperand coord2)
        Sets the second coordinate of the center (i.e. declination).
        Parameters:
        coord2 - The second coordinate.
      • getRadius

        public final ADQLOperand getRadius()
        Gets the radius of the center.
        Returns:
        The radius.
      • setRadius

        public final void setRadius​(ADQLOperand radius)
        Sets the radius of the center.
        Parameters:
        radius - The radius.
      • 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 java.lang.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:
        java.lang.ArrayIndexOutOfBoundsException - If the index is incorrect (index < 0 || index >= getNbParameters()).
      • setParameter

        public ADQLOperand setParameter​(int index,
                                        ADQLOperand replacer)
                                 throws java.lang.ArrayIndexOutOfBoundsException,
                                        java.lang.NullPointerException,
                                        java.lang.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:
        java.lang.ArrayIndexOutOfBoundsException - If the index is incorrect (index < 0 || index >= getNbParameters()).
        java.lang.NullPointerException - If a required parameter must be replaced by a NULL object.
        java.lang.Exception - If another error occurs.