Class ContainsFunction

All Implemented Interfaces:
ADQLObject, ADQLOperand

public class ContainsFunction extends GeometryFunction
It represents the CONTAINS function of the ADQL language.

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

Example:

An expression to determine whether the point (25.0, -19.5) degrees is within a circle of ten degrees radius centered on position (25.4, -20.0) degrees, could be written as follows:

CONTAINS(POINT(25.0, -19.5), CIRCLE(25.4, -20.0, 10.0))

The CONTAINS function is not symmetric in the meaning of the arguments.

The CONTAINS function returns the numeric value 1 if the first argument is in, or on, the boundary of the second argument and the numeric value 0 if it is not.

When used as a predicate in the WHERE clause of a query, the numeric return value must be compared to the numeric values 0 or 1 to form a SQL predicate:

Example:

WHERE 1 = CONTAINS(POINT(25.0, -19.5), CIRCLE(25.4, -20.0, 10.0))

for "does contain" and

WHERE 0 = CONTAINS(POINT(25.0, -19.5), CIRCLE(25.4, -20.0, 10.0))

for "does not contain".

The geometric arguments for CONTAINS may be literal values, as above, or they may be column references, functions or expressions that return geometric values.

Example:

WHERE 0 = CONTAINS(t1.center, t2.footprint)

, where t1.center and t2.footprint are references to database columns that contain POINT and geometric (BOX, CIRCLE, POLYGON or REGION) values respectively.

If the geometric arguments are expressed in different coordinate systems, the CONTAINS function is responsible for converting one, or both, of the arguments into a different coordinate system. If the CONTAINS function cannot perform the required conversion then it SHOULD throw an error. Details of the mechanism for reporting the error condition are implementation dependent.

  • Field Details

    • FEATURE

      public static final LanguageFeature FEATURE
      Description of this ADQL Feature.
      Since:
      2.0
  • Constructor Details

  • Method Details

    • getFeatureDescription

      public final LanguageFeature getFeatureDescription()
      Description copied from interface: ADQLObject
      Get the description of this ADQL's Language Feature.

      Note: Getting this description is generally only useful when discovery optional features so that determining if they are allowed to be used in ADQL queries.

      Returns:
      Description of this ADQL object as an ADQL's feature.
    • getCopy

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

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

      public final GeometryFunction.GeometryValue<GeometryFunction> getLeftParam()
      Returns:
      The leftParam.
    • setLeftParam

      public final void setLeftParam(GeometryFunction.GeometryValue<GeometryFunction> leftParam)
      Parameters:
      leftParam - The leftParam to set.
    • getRightParam

      public final GeometryFunction.GeometryValue<GeometryFunction> getRightParam()
      Returns:
      The rightParam.
    • setRightParam

      public final void setRightParam(GeometryFunction.GeometryValue<GeometryFunction> rightParam)
      Parameters:
      rightParam - The rightParam to set.
    • getParameters

      public ADQLOperand[] getParameters()
      Description copied from class: ADQLFunction
      Gets the list of all parameters of this function.
      Specified by:
      getParameters in class ADQLFunction
      Returns:
      Its parameters list.
    • 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 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:
      ArrayIndexOutOfBoundsException - If the index is incorrect (index invalid input: '<' 0 || index >= getNbParameters()).
    • setParameter

      public ADQLOperand setParameter(int index, ADQLOperand replacer) throws ArrayIndexOutOfBoundsException, NullPointerException, 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:
      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.