Class CircleFunction
java.lang.Object
adql.query.operand.function.ADQLFunction
adql.query.operand.function.geometry.GeometryFunction
adql.query.operand.function.geometry.CircleFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
It represents the CIRCLE function of the ADQL language.
This function expresses a circular region on the sky (a cone in space) and corresponds semantically to the STC circle region. The function arguments specify the coordinate system, the center position, and the radius (in degrees).
Example:
CIRCLE('ICRS GEOCENTER', 25.4, -20.0, 1)
In this example the function expresses a circle of one degree radius centered in a position of (25.4, -20.0) degrees and defined
according to the ICRS coordinate system with GEOCENTER reference position.
- Version:
- 1.4 (06/2015)
- Author:
- Grégory Mantelet (CDS;ARI)
-
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
Fields inherited from class adql.query.operand.function.geometry.GeometryFunction
coordSys
-
Constructor Summary
ConstructorsConstructorDescriptionCircleFunction
(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord, ADQLOperand radius) Builds a CIRCLE function.CircleFunction
(CircleFunction toCopy) Builds a CIRCLE function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptionfinal ADQLOperand
Gets the first coordinate of the center (i.e.final ADQLOperand
Gets the second coordinate of the center (i.e.getCopy()
Gets a (deep) copy of this ADQL object.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.final ADQLOperand
Gets the radius of the center.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.final void
setCoord1
(ADQLOperand coord1) Sets the first coordinate of the center (i.e.final void
setCoord2
(ADQLOperand coord2) Sets the second coordinate of the center (i.e.setParameter
(int index, ADQLOperand replacer) Replaces the index-th parameter by the given one.final void
setRadius
(ADQLOperand radius) Sets the radius of the center.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
-
Constructor Details
-
CircleFunction
public CircleFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord, ADQLOperand radius) throws NullPointerException, Exception Builds a CIRCLE function.- Parameters:
coordinateSystem
- The coordinate system in which the center position is expressed.firstCoord
- The first coordinate of the center position.secondCoord
- The second coordinate of the center position.radius
- The radius of the circle (in degrees).- Throws:
NullPointerException
- If at least one parameter is incorrect or if the coordinate system is unknown.Exception
- If there is another error.
-
CircleFunction
Builds a CIRCLE function by copying the given one.- Parameters:
toCopy
- The CIRCLE function to copy.- Throws:
Exception
- If there is an error during the copy.
-
-
Method Details
-
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.
-
getCoord1
Gets the first coordinate of the center (i.e. right ascension).- Returns:
- The first coordinate.
-
setCoord1
Sets the first coordinate of the center (i.e. right ascension).- Parameters:
coord1
- The first coordinate.
-
getCoord2
Gets the second coordinate of the center (i.e. declination).- Returns:
- The second coordinate.
-
setCoord2
Sets the second coordinate of the center (i.e. declination).- Parameters:
coord2
- The second coordinate.
-
getRadius
Gets the radius of the center.- Returns:
- The radius.
-
setRadius
Sets the radius of the center.- Parameters:
radius
- The radius.
-
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.
-