public class PointFunction extends GeometryFunction
It represents the POINT function of the ADQL language.
This function expresses a single location on the sky, and corresponds semantically to an STC SpatialCoord. The arguments specify the coordinate system and the position.
Example:
POINT('ICRS GEOCENTER', 25.0, -19.5)
In this example the function expresses a point with right ascension of 25 degrees and declination of -19.5 degrees according
to the ICRS coordinate system with GEOCENTER reference position.
GeometryFunction.GeometryValue<F extends GeometryFunction>
ADQLFunction.ParameterIterator
coordSys
Constructor and Description |
---|
PointFunction(ADQLOperand coordinateSystem,
ADQLOperand firstCoord,
ADQLOperand secondCoord)
Builds a POINT function.
|
PointFunction(PointFunction toCopy)
Builds a POINT function by copying the given one.
|
Modifier and Type | Method and Description |
---|---|
ADQLOperand |
getCoord1()
Gets the first coordinate of this point.
|
ADQLOperand |
getCoord2()
Gets the second coordinate of this point.
|
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.
|
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)
Changes the first coordinate of this POINT function.
|
void |
setCoord2(ADQLOperand coord2)
Changes the second coordinate of this POINT function.
|
ADQLOperand |
setParameter(int index,
ADQLOperand replacer)
Replaces the index-th parameter by the given one.
|
getCoordinateSystem, setCoordinateSystem
adqlIterator, getPosition, paramIterator, setPosition, toADQL
public PointFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException, java.lang.Exception
coordinateSystem
- The coordinate system to use.firstCoord
- The first coordinate.secondCoord
- The second coordinate.java.lang.UnsupportedOperationException
- If this function is not associated with a coordinate system.java.lang.NullPointerException
- If the given operand is null.ParseException
- If at least one of the given parameters is incorrect.java.lang.Exception
public PointFunction(PointFunction toCopy) throws java.lang.Exception
toCopy
- The POINT function to copy.java.lang.Exception
- If there is an error during the copy.public final ADQLOperand getCoord1()
public void setCoord1(ADQLOperand coord1) throws java.lang.NullPointerException, java.lang.Exception
coord1
- Its new first coordinate.java.lang.NullPointerException
- If the given operand is null.java.lang.Exception
- If the given operand is not numeric.public final ADQLOperand getCoord2()
public void setCoord2(ADQLOperand coord2) throws java.lang.NullPointerException, java.lang.Exception
coord2
- Its new second coordinate.java.lang.NullPointerException
- If the given operand is null.java.lang.Exception
- If the given operand is not numeric.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 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.