Package adql.query.operand.function.geometry

Class ContainsFunction

  • All Implemented Interfaces:
    ADQLObject, ADQLOperand
    public class ContainsFunction
extends GeometryFunction

    It represents the CONTAINS function of the ADQL language.

    This numeric function determines if a geometry is wholly contained within another. This is most commonly used to express the "point-in-shape" condition.

    Example:
    CONTAINS(POINT('ICRS GEOCENTER', 25.0, -19.5), CIRCLE('ICRS GEOCENTER', 25.4, -20.0, 1)) = 1
    In this example the function determines if the point (25.0,-19.5) is within a circle of one degree radius centered in a position of (25.4,-20.0).

    Warning:

    • The CONTAINS function returns 1 (true) if the first argument is in or on the boundary of the circle and 0 (false) otherwise.
    • Since the two argument geometries may be expressed in different coordinate systems, the function is responsible for converting one (or both). If it can not do so, it SHOULD throw an error message, to be defined by the service making use of ADQL.

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

    • Constructor Detail

      • ContainsFunction

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