Package adql.query.operand.function

Class ADQLFunction

java.lang.Object
adql.query.operand.function.ADQLFunction
All Implemented Interfaces:
ADQLObject, ADQLOperand
Direct Known Subclasses:
CastFunction, CoalesceFunction, GeometryFunction, InUnitFunction, LowerFunction, MathFunction, SQLFunction, UpperFunction, UserDefinedFunction
public abstract class ADQLFunction extends Object implements ADQLOperand
Represents any kind of function.

  • Constructor Details

    • ADQLFunction

      public ADQLFunction()

  • Method Details

    • 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 ArrayIndexOutOfBoundsException
      Gets the index-th parameter.
      Parameters:
      index - Parameter number.
      Returns:
      The corresponding parameter.
      Throws:
      ArrayIndexOutOfBoundsException - If the index is incorrect (index invalid input: '<' 0 || index >= getNbParameters()).

    • setParameter

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

    • paramIterator

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

    • adqlIterator

      public ADQLIterator adqlIterator()
      Description copied from interface: ADQLObject
      Gets an iterator on the intern ADQL objects.

      Note: The returned iterator is particularly used by a ISearchHandler extension to browse a whole ADQL tree.

      Specified by:
      adqlIterator in interface ADQLObject
      Returns:
      An ADQL objects iterator.
      See Also:

    • toADQL

      public 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.