Class ADQLFunction

    • Constructor Detail

      • ADQLFunction

        public ADQLFunction()
    • Method Detail

      • getPosition

        public final TextPosition getPosition()
        Description copied from interface: ADQLObject

        Gets the position of this object/token in the ADQL query.

        By default, no position should be set.

        Specified by:
        getPosition in interface ADQLObject
        Returns:
        Position of this ADQL item in the ADQL query, or NULL if not written originally in the query (for example, if added afterwards.
      • setPosition

        public final void setPosition​(TextPosition position)
        Set the position of this ADQLFunction in the ADQL query string.
        Parameters:
        position - New position of this ADQLFunction
        Since:
        1.4
      • getNbParameters

        public abstract int getNbParameters()
        Gets the number of parameters this function has.
        Returns:
        Number of parameters.
      • getParameters

        public abstract ADQLOperand[] getParameters()
        Gets the list of all parameters of this function.
        Returns:
        Its parameters list.
      • getParameter

        public abstract ADQLOperand getParameter​(int index)
                                          throws java.lang.ArrayIndexOutOfBoundsException
        Gets the index-th parameter.
        Parameters:
        index - Parameter number.
        Returns:
        The corresponding parameter.
        Throws:
        java.lang.ArrayIndexOutOfBoundsException - If the index is incorrect (index < 0 || index >= getNbParameters()).
      • setParameter

        public abstract ADQLOperand setParameter​(int index,
                                                 ADQLOperand replacer)
                                          throws java.lang.ArrayIndexOutOfBoundsException,
                                                 java.lang.NullPointerException,
                                                 java.lang.Exception
        Replaces the index-th parameter by the given one.
        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.
      • paramIterator

        public java.util.Iterator<ADQLOperand> paramIterator()
        Creates an iterator on the parameters of this function.
        Returns:
        Parameters iterator.
      • toADQL

        public java.lang.String toADQL()
        Description copied from interface: ADQLObject
        Gets the ADQL expression of this object.
        Specified by:
        toADQL in interface ADQLObject
        Returns:
        The corresponding ADQL expression.