Class ExtractCoord
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
These functions extract resp. the first and the second coordinate value, in degrees, of a given POINT or column reference.
Example for COORD1:
The right ascension of a point with position (25, -19.5) in degrees would be obtained using the following expression:
COORD1(POINT(25.0, -19.5))
, which would return a numeric value of 25.0 degrees.
And:
COORD1(t.center)
, where t.center is a reference to a column that contains POINT values.
Example for COORD2:
The declination of a point with position (25, -19.5) in degrees, could be obtained using the following expression:
COORD2(POINT(25.0, -19.5))
, which would return a numeric value of -19.5 degrees.
And:
COORD2(t.center)
, where t.center is a reference to a column that contains POINT values.
-
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 TypeFieldDescriptionstatic final LanguageFeature
Description of this ADQL Feature (COORD1).static final LanguageFeature
Description of this ADQL Feature (COORD2).protected final int
Number of the coordinate to extract (1 or 2).protected GeometryFunction.GeometryValue
<PointFunction> The point from which the coordinate must be extracted.Fields inherited from class adql.query.operand.function.geometry.GeometryFunction
coordSys
-
Constructor Summary
ConstructorsConstructorDescriptionExtractCoord
(int indiceCoord, GeometryFunction.GeometryValue<PointFunction> p) Builds a COORD1 or a COORD2 function with the given point (a POINT function or a column which contains a POINT function).ExtractCoord
(ExtractCoord toCopy) Builds a COORD1 or a COORD2 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 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.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_COORD1
Description of this ADQL Feature (COORD1).- Since:
- 2.0
-
FEATURE_COORD2
Description of this ADQL Feature (COORD2).- Since:
- 2.0
-
indCoord
protected final int indCoordNumber of the coordinate to extract (1 or 2). -
point
The point from which the coordinate must be extracted.
-
-
Constructor Details
-
ExtractCoord
public ExtractCoord(int indiceCoord, GeometryFunction.GeometryValue<PointFunction> p) throws ArrayIndexOutOfBoundsException, NullPointerException Builds a COORD1 or a COORD2 function with the given point (a POINT function or a column which contains a POINT function).- Parameters:
indiceCoord
- 1 or 2: the index of the coordinate to extract.p
- The POINT function from which the indiceCoord-th coordinate must be extracted.- Throws:
ArrayIndexOutOfBoundsException
- If the given index is different from 1 and 2.NullPointerException
- If the given geometry is NULL.
-
ExtractCoord
Builds a COORD1 or a COORD2 function by copying the given one.- Parameters:
toCopy
- The COORD1 or the COORD2 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.
-
getName
Description copied from interface:ADQLObject
Gets the name of this object in ADQL.- Returns:
- The name of this ADQL object.
-
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.
-
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
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.
-