Class PolygonFunction

  • All Implemented Interfaces:
    ADQLObject, ADQLOperand

    public class PolygonFunction
    extends GeometryFunction

    It represents the POLYGON function of the ADQL language.

    This function expresses a region on the sky with sides denoted by great circles passing through specified coordinates. It corresponds semantically to the STC Polygon region. The arguments specify the coordinate system and three or more sets of 2-D coordinates.

    The polygon is a list of vertices in a single coordinate system, with each vertex connected to the next along a great circle and the last vertex implicitly connected to the first vertex.

    Example:
    POLYGON('ICRS GEOCENTER', 10.0, -10.5, 20.0, 20.5, 30.0, 30.5)
    In this example the function expresses a triangle, whose vertices are (10.0, -10.5), (20.0, 20.5) and (30.0, 30.5) in degrees according to the STC coordinate system with GEOCENTER reference position.

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

      • coordinates

        protected java.util.Vector<ADQLOperand> coordinates
        The coordinates of vertices.
    • Constructor Detail

      • PolygonFunction

        public PolygonFunction​(ADQLOperand coordSystem,
                               ADQLOperand[] coords)
                        throws java.lang.UnsupportedOperationException,
                               java.lang.NullPointerException,
                               java.lang.Exception
        Builds a polygon function with at least 3 2-D coordinates (that is to say, the array must contain at least 6 operands).
        Parameters:
        coordSystem - A string operand which corresponds to a valid coordinate system.
        coords - An array of at least 3 2-D coordinates (length>=6).
        Throws:
        java.lang.UnsupportedOperationException - If this function is not associated with a coordinate system.
        java.lang.NullPointerException - If one of the parameters is null.
        java.lang.Exception - If there is another error.
      • PolygonFunction

        public PolygonFunction​(ADQLOperand coordSystem,
                               java.util.Collection<? extends ADQLOperand> coords)
                        throws java.lang.UnsupportedOperationException,
                               java.lang.NullPointerException,
                               java.lang.Exception
        Builds a polygon function with at least 3 2-D coordinates (that is to say, the vector must contain at least 6 operands).
        Parameters:
        coordSystem - A string operand which corresponds to a valid coordinate system.
        coords - A vector of at least 3 2-D coordinates (size()>=6).
        Throws:
        java.lang.UnsupportedOperationException - If this function is not associated with a coordinate system.
        java.lang.NullPointerException - If one of the parameters is null.
        java.lang.Exception - If there is another error.
      • PolygonFunction

        public PolygonFunction​(PolygonFunction toCopy)
                        throws java.lang.Exception
        Builds a POLYGON function by copying the given one.
        Parameters:
        toCopy - The POLYGON 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.
      • 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.