public class CircleFunction extends GeometryFunction
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.
GeometryFunction.GeometryValue<F extends GeometryFunction>
ADQLFunction.ParameterIterator
coordSys
Constructor and Description |
---|
CircleFunction(ADQLOperand coordinateSystem,
ADQLOperand firstCoord,
ADQLOperand secondCoord,
ADQLOperand radius)
Builds a CIRCLE function.
|
CircleFunction(CircleFunction toCopy)
Builds a CIRCLE function by copying the given one.
|
Modifier and Type | Method and Description |
---|---|
ADQLOperand |
getCoord1()
Gets the first coordinate of the center (i.e.
|
ADQLOperand |
getCoord2()
Gets the second coordinate of the center (i.e.
|
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.
|
ADQLOperand |
getRadius()
Gets the radius of the center.
|
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.
|
void |
setCoord1(ADQLOperand coord1)
Sets the first coordinate of the center (i.e.
|
void |
setCoord2(ADQLOperand coord2)
Sets the second coordinate of the center (i.e.
|
ADQLOperand |
setParameter(int index,
ADQLOperand replacer)
Replaces the index-th parameter by the given one.
|
void |
setRadius(ADQLOperand radius)
Sets the radius of the center.
|
getCoordinateSystem, setCoordinateSystem
adqlIterator, getPosition, paramIterator, setPosition, toADQL
public CircleFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord, ADQLOperand radius) throws java.lang.NullPointerException, java.lang.Exception
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).java.lang.NullPointerException
- If at least one parameter is incorrect or if the coordinate system is unknown.java.lang.Exception
- If there is another error.public CircleFunction(CircleFunction toCopy) throws java.lang.Exception
toCopy
- The CIRCLE function to copy.java.lang.Exception
- If there is an error during the copy.public ADQLObject getCopy() throws java.lang.Exception
ADQLObject
java.lang.Exception
- If there is any error during the copy.public java.lang.String getName()
ADQLObject
public boolean isNumeric()
ADQLOperand
public boolean isString()
ADQLOperand
public boolean isGeometry()
ADQLOperand
public final ADQLOperand getCoord1()
public final void setCoord1(ADQLOperand coord1)
coord1
- The first coordinate.public final ADQLOperand getCoord2()
public final void setCoord2(ADQLOperand coord2)
coord2
- The second coordinate.public final ADQLOperand getRadius()
public final void setRadius(ADQLOperand radius)
radius
- The radius.public ADQLOperand[] getParameters()
ADQLFunction
getParameters
in class ADQLFunction
public int getNbParameters()
ADQLFunction
getNbParameters
in class ADQLFunction
public ADQLOperand getParameter(int index) throws java.lang.ArrayIndexOutOfBoundsException
ADQLFunction
getParameter
in class ADQLFunction
index
- Parameter number.java.lang.ArrayIndexOutOfBoundsException
- If the index is incorrect (index < 0 || index >= getNbParameters()).public ADQLOperand setParameter(int index, ADQLOperand replacer) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.NullPointerException, java.lang.Exception
ADQLFunction
setParameter
in class ADQLFunction
index
- Index of the parameter to replace.replacer
- The replacer.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.