Class PolygonFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
It represents the POLYGON function of the ADQL language.
This function expresses a region on the sky with sides denoted by great circles passing through specified coordinates. It corresponds semantically to the STC Polygon region. The arguments specify the coordinate system and three or more sets of 2-D coordinates.
The polygon is a list of vertices in a single coordinate system, with each vertex connected to the next along a great circle and the last vertex implicitly connected to the first vertex.
Example:
POLYGON('ICRS GEOCENTER', 10.0, -10.5, 20.0, 20.5, 30.0, 30.5)
In this example the function expresses a triangle, whose vertices are (10.0, -10.5), (20.0, 20.5) and (30.0, 30.5) in degrees
according to the STC 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
FieldsFields inherited from class adql.query.operand.function.geometry.GeometryFunction
coordSys
-
Constructor Summary
ConstructorsConstructorDescriptionPolygonFunction
(ADQLOperand coordSystem, ADQLOperand[] coords) Builds a polygon function with at least 3 2-D coordinates (that is to say, the array must contain at least 6 operands).PolygonFunction
(ADQLOperand coordSystem, Collection<? extends ADQLOperand> coords) Builds a polygon function with at least 3 2-D coordinates (that is to say, the vector must contain at least 6 operands).PolygonFunction
(PolygonFunction toCopy) Builds a POLYGON function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptiongetCopy()
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.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
-
coordinates
The coordinates of vertices.
-
-
Constructor Details
-
PolygonFunction
public PolygonFunction(ADQLOperand coordSystem, ADQLOperand[] coords) throws UnsupportedOperationException, NullPointerException, Exception Builds a polygon function with at least 3 2-D coordinates (that is to say, the array must contain at least 6 operands).- Parameters:
coordSystem
- A string operand which corresponds to a valid coordinate system.coords
- An array of at least 3 2-D coordinates (length>=6).- Throws:
UnsupportedOperationException
- If this function is not associated with a coordinate system.NullPointerException
- If one of the parameters is null.Exception
- If there is another error.
-
PolygonFunction
public PolygonFunction(ADQLOperand coordSystem, Collection<? extends ADQLOperand> coords) throws UnsupportedOperationException, NullPointerException, Exception Builds a polygon function with at least 3 2-D coordinates (that is to say, the vector must contain at least 6 operands).- Parameters:
coordSystem
- A string operand which corresponds to a valid coordinate system.coords
- A vector of at least 3 2-D coordinates (size()>=6).- Throws:
UnsupportedOperationException
- If this function is not associated with a coordinate system.NullPointerException
- If one of the parameters is null.Exception
- If there is another error.
-
PolygonFunction
Builds a POLYGON function by copying the given one.- Parameters:
toCopy
- The POLYGON 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.
-
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.
-