Class RegionFunction

All Implemented Interfaces:
ADQLObject, ADQLOperand

public class RegionFunction extends GeometryFunction
It represents the REGION function the ADQL language.

This function (removed from ADQL since v2.1) provides a generic way of expressing a region represented by a single string input parameter. The format of the string MUST be specified by a service that accepts ADQL by referring to a standard format. Currently STC/s is the only standardized string representation a service can declare.

Example:

REGION('Convex ... Position ... Error ... Size')

In this example the function embeds a string serialization of an STC region within parenthesis.

Warning: Inappropriate geometries for this construct SHOULD throw an error message, to be defined by the service making use of ADQL.

  • Field Details

    • FEATURE

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

      public static final LanguageFeature FEATURE_UNION
      Description of this special geometry operation: UNION.

      Implementation note: There is no corresponding ADQL function for the moment. In the meantime, this language feature stands here.

      Since:
      2.0
    • FEATURE_INTERSECT

      public static final LanguageFeature FEATURE_INTERSECT
      Description of this special geometry operation: INTERSECT.

      Implementation note: There is no corresponding ADQL function for the moment. In the meantime, this language feature stands here.

      Since:
      2.0
    • parameter

      protected ADQLOperand parameter
      The only parameter of this function.
    • extendedRegionExpression

      protected boolean extendedRegionExpression
      Indicate whether only a string literal using a supported serialization (e.g. DALI, STC/s) is allowed (standard and default behavior) or not.

      Note: If false, JDBCTranslator will resolve this REGION function into the corresponding ADQL geometry which it will finally translate. If true, JDBCTranslator will by default translate this REGION function exactly as in ADQL.

      Since:
      2.0
  • Constructor Details

    • RegionFunction

      public RegionFunction(ADQLOperand param) throws Exception
      Builds a REGION function.
      Parameters:
      param - The parameter (a string or a column reference or a concatenation or a user function).
      Throws:
      NullPointerException - If the given parameter is NULL.
      Exception - If the given operand does not represent a string value.
    • RegionFunction

      public RegionFunction(RegionFunction toCopy) throws Exception
      Builds a REGION function by copying the given one.
      Parameters:
      toCopy - The REGION function to copy.
      Throws:
      Exception - If there is an error during the copy.
  • 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.
    • isExtendedRegionExpression

      public boolean isExtendedRegionExpression()
      Tell whether the parameter of this REGION function aims to be a simple string literal using a supported serialization (e.g. DALI, STC/s) or not (i.e. any serialization and/or any kind or string expression).
      Returns:
      false if the region is expressed with a string literal/constant using a supported serialization, true if it can be something else than a string literal/constant or if it may use a different serialization.
      Since:
      2.0
    • setExtendedRegionExpression

      public void setExtendedRegionExpression(boolean extendedExpression)
      Set whether the parameter of this REGION function may be something else than a string literal/constant or may use a non-supported serialization (e.g. something else than DALI and STC/s).

      Note: If false, JDBCTranslator will resolve this REGION function into the corresponding ADQL geometry which it will finally translate. If true, JDBCTranslator will by default translate this REGION function exactly as in ADQL.

      Parameters:
      extendedExpression - false if the region must be expressed with a string literal/constant using a supported serialization, true if it can be something else than a string literal/constant or if it may use a different serialization.
      Since:
      2.0
    • 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.