Class RegionFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class adql.query.operand.function.geometry.GeometryFunction
GeometryFunction.GeometryValue<F extends GeometryFunction>
Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
ADQLFunction.ParameterIterator
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Indicate whether only a string literal using a supported serialization (e.g.static final LanguageFeature
Description of this ADQL Feature.static final LanguageFeature
Description of this special geometry operation: INTERSECT.static final LanguageFeature
Description of this special geometry operation: UNION.protected ADQLOperand
The only parameter of this function.Fields inherited from class adql.query.operand.function.geometry.GeometryFunction
coordSys
-
Constructor Summary
ConstructorsConstructorDescriptionRegionFunction
(ADQLOperand param) Builds a REGION function.RegionFunction
(RegionFunction toCopy) Builds a REGION function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptiongetCopy()
Gets a (deep) copy of this ADQL object.final LanguageFeature
Get the description of this ADQL's Language Feature.getName()
Gets the name of this object in ADQL.int
Gets the number of parameters this function has.getParameter
(int index) Gets the index-th parameter.Gets the list of all parameters of this function.boolean
Tell whether the parameter of this REGION function aims to be a simple string literal using a supported serialization (e.g.boolean
Tell whether this operand is a geometrical region or not.boolean
Tell whether this operand is numeric or not.boolean
isString()
Tell whether this operand is a string or not.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.setParameter
(int index, ADQLOperand replacer) Replaces the index-th parameter by the given one.Methods inherited from class adql.query.operand.function.geometry.GeometryFunction
getCoordinateSystem, setCoordinateSystem
Methods inherited from class adql.query.operand.function.ADQLFunction
adqlIterator, getPosition, paramIterator, setPosition, toADQL
-
Field Details
-
FEATURE
Description of this ADQL Feature.- Since:
- 2.0
-
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
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
The only parameter of this function. -
extendedRegionExpression
protected boolean extendedRegionExpressionIndicate 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. Iftrue
,JDBCTranslator
will by default translate this REGION function exactly as in ADQL.- Since:
- 2.0
-
-
Constructor Details
-
RegionFunction
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
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
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
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
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. Iftrue
,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
Description copied from class:ADQLFunction
Gets the list of all parameters of this function.- Specified by:
getParameters
in classADQLFunction
- 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 classADQLFunction
- Returns:
- Number of parameters.
-
getParameter
Description copied from class:ADQLFunction
Gets the index-th parameter.- Specified by:
getParameter
in classADQLFunction
- 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 classADQLFunction
- 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.
-