Class PointFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
This function expresses a single location on the sky, and it corresponds semantically to the equivalent term, SpatialCoord, defined in the STC specification.
The function arguments specify the position, where:
- the position is given by a pair of numeric coordinates in degrees
- the numeric coordinates MUST be within the ranges resp. [0,360] and [-90,90].
Example:
A function expressing a point with right ascension of 25 degrees and declination of -19.5 degrees would be written as follows:
POINT(25.0, -19.5)
, where numeric values are in degrees.
The coordinates for POINT may be literal values, as above, or they may be column references, functions or expressions that return numeric values.
Example:
POINT(t.ra, t.dec)
, where t.ra and t.dec are references to database columns that contain numeric values.
For historical reasons, the POINT function accepts an optional string value as the first argument. As of this version of the specification (2.1) this parameter has been marked as deprecated. Future versions of this specification (> 2.1) may remove this parameter.
-
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
FieldsFields inherited from class adql.query.operand.function.geometry.GeometryFunction
coordSys
-
Constructor Summary
ConstructorsConstructorDescriptionPointFunction
(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord) Builds a POINT function.PointFunction
(PointFunction toCopy) Builds a POINT function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptionfinal ADQLOperand
Gets the first coordinate of this point.final ADQLOperand
Gets the second coordinate of this point.getCopy()
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.void
setCoord1
(ADQLOperand coord1) Changes the first coordinate of this POINT function.void
setCoord2
(ADQLOperand coord2) Changes the second coordinate of this POINT function.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
-
-
Constructor Details
-
PointFunction
public PointFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord) throws UnsupportedOperationException, NullPointerException, Exception Builds a POINT function.- Parameters:
coordinateSystem
- The coordinate system to use.firstCoord
- The first coordinate.secondCoord
- The second coordinate.- Throws:
UnsupportedOperationException
- If this function is not associated with a coordinate system.NullPointerException
- If the given operand is NULL.ParseException
- If at least one of the given parameters is incorrect.Exception
-
PointFunction
Builds a POINT function by copying the given one.- Parameters:
toCopy
- The POINT 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.
-
getCoord1
Gets the first coordinate of this point.- Returns:
- Its first coordinate.
-
setCoord1
Changes the first coordinate of this POINT function.- Parameters:
coord1
- Its new first coordinate.- Throws:
NullPointerException
- If the given operand is null.Exception
- If the given operand is not numeric.
-
getCoord2
Gets the second coordinate of this point.- Returns:
- Its second coordinate.
-
setCoord2
Changes the second coordinate of this POINT function.- Parameters:
coord2
- Its new second coordinate.- Throws:
NullPointerException
- If the given operand is null.Exception
- If the given operand is not numeric.
-
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.
-
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 < 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 < 0 || index >= getNbParameters()).NullPointerException
- If a required parameter must be replaced by a NULL object.Exception
- If another error occurs.
-