RegionFunction

java.lang.Object
- adql.query.operand.function.ADQLFunction
- - adql.query.operand.function.geometry.GeometryFunction
  - - adql.query.operand.function.geometry.RegionFunction

All Implemented Interfaces:

ADQLObject, ADQLOperand
```
public class RegionFunction
extends GeometryFunction
```
It represents the REGION function the ADQL language.

This function 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.

Version:

1.4 (06/2015)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary
- Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
  ADQLFunction.ParameterIterator
- Nested classes/interfaces inherited from class adql.query.operand.function.geometry.GeometryFunction
  GeometryFunction.GeometryValue<F extends GeometryFunction>

Field Summary

Fields
Modifier and Type Field Description

protected ADQLOperand parameter
The only parameter of this function.
- Fields inherited from class adql.query.operand.function.geometry.GeometryFunction
  coordSys

Fields
Modifier and Type	Field	Description
`protected ADQLOperand`	`parameter`	The only parameter of this function.

Constructor Summary

Constructors
Constructor	Description
`RegionFunction(ADQLOperand param)`	Builds a REGION function.
`RegionFunction(RegionFunction toCopy)`	Builds a REGION function by copying the given one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ADQLObject`	`getCopy()`	Gets a (deep) copy of this ADQL object.
`java.lang.String`	`getName()`	Gets the name of this object in ADQL.
`int`	`getNbParameters()`	Gets the number of parameters this function has.
`ADQLOperand`	`getParameter(int index)`	Gets the index-th parameter.
`ADQLOperand[]`	`getParameters()`	Gets the list of all parameters of this function.
`boolean`	`isGeometry()`	Tell whether this operand is a geometrical region or not.
`boolean`	`isNumeric()`	Tell whether this operand is numeric or not.
`boolean`	`isString()`	Tell whether this operand is a string or not.
`ADQLOperand`	`setParameter(int index, ADQLOperand replacer)`	Replaces the index-th parameter by the given one.

Methods inherited from class adql.query.operand.function.ADQLFunction
adqlIterator, getPosition, paramIterator, setPosition, toADQL

Methods inherited from class adql.query.operand.function.geometry.GeometryFunction
getCoordinateSystem, setCoordinateSystem

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - parameter
```
protected ADQLOperand parameter
```
    The only parameter of this function.
- Constructor Detail
  - RegionFunction
```
public RegionFunction(ADQLOperand param)
               throws java.lang.NullPointerException,
                      java.lang.Exception
```
    Builds a REGION function.
    
    Parameters:
    
    param - The parameter (a string or a column reference or a concatenation or a user function).
    
    Throws:
    
    ParseException - If the given parameter is null.
    
    java.lang.NullPointerException
    
    java.lang.Exception
  - RegionFunction
```
public RegionFunction(RegionFunction toCopy)
               throws java.lang.Exception
```
    Builds a REGION function by copying the given one.
    
    Parameters:
    
    toCopy - The REGION 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.
  - 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 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.

Class RegionFunction

Nested Class Summary

Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction

Nested classes/interfaces inherited from class adql.query.operand.function.geometry.GeometryFunction

Field Summary

Fields inherited from class adql.query.operand.function.geometry.GeometryFunction

Constructor Summary

Method Summary

Methods inherited from class adql.query.operand.function.ADQLFunction

Methods inherited from class adql.query.operand.function.geometry.GeometryFunction

Methods inherited from class java.lang.Object

Field Detail

parameter

Constructor Detail

RegionFunction

RegionFunction

Method Detail

getCopy

getName

isNumeric

isString

isGeometry

getParameters

getNbParameters

getParameter

setParameter