Class BoxFunction
- java.lang.Object
-
- adql.query.operand.function.ADQLFunction
-
- adql.query.operand.function.geometry.GeometryFunction
-
- adql.query.operand.function.geometry.BoxFunction
-
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
public class BoxFunction extends GeometryFunction
It represents the box function of the ADQL language.
It is specified by a center position and a size (in both coordinates). The coordinates of the center position are expressed in the given coordinate system. The size of the box is in degrees.
Example:
BOX('ICRS GEOCENTER', 25.4, -20.0, 10, 10)
In this example the function expressing a box o ten degrees centered in a position (25.4,-20.0) in degrees and defined according to the ICRS coordinate system with GEOCENTER reference position.
BOX('ICRS GEOCENTER', t.ra, t.dec, 10, 10)
In this second example the coordinates of the center position are extracted from a coordinate's column reference.- 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
Constructors Constructor Description BoxFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord, ADQLOperand boxWidth, ADQLOperand boxHeight)
Builds a BOX function.BoxFunction(BoxFunction toCopy)
Builds a BOX function by copying the given one.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ADQLOperand
getCoord1()
Gets the first coordinate (i.e.ADQLOperand
getCoord2()
Gets the second coordinate (i.e.ADQLObject
getCopy()
Gets a (deep) copy of this ADQL object.ADQLOperand
getHeight()
Gets the height of the box.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
getWidth()
Gets the width of the box.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 (i.e.void
setCoord2(ADQLOperand coord2)
Sets the second coordinate (i.e.void
setHeight(ADQLOperand height)
Sets the height of the box.ADQLOperand
setParameter(int index, ADQLOperand replacer)
Replaces the index-th parameter by the given one.void
setWidth(ADQLOperand width)
Sets the width of the box.-
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 Detail
-
BoxFunction
public BoxFunction(ADQLOperand coordinateSystem, ADQLOperand firstCoord, ADQLOperand secondCoord, ADQLOperand boxWidth, ADQLOperand boxHeight) throws java.lang.NullPointerException, java.lang.Exception
Builds a BOX function.
- Parameters:
coordinateSystem
- The coordinate system of the center position.firstCoord
- The first coordinate of the center of this box.secondCoord
- The second coordinate of the center of this box.boxWidth
- The width of this box (in degrees).boxHeight
- The height of this box (in degrees).- Throws:
java.lang.NullPointerException
- If one parameter is null.java.lang.Exception
- If there is another error.
-
BoxFunction
public BoxFunction(BoxFunction toCopy) throws java.lang.Exception
Builds a BOX function by copying the given one.- Parameters:
toCopy
- The BOX function to copy.- Throws:
java.lang.Exception
- If there is an error during the copy.
-
-
Method Detail
-
getCopy
public ADQLObject getCopy() throws java.lang.Exception
Description copied from interface:ADQLObject
Gets a (deep) copy of this ADQL object.- Returns:
- The copy of this ADQL object.
- Throws:
java.lang.Exception
- If there is any error during the copy.
-
getName
public java.lang.String 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
public final ADQLOperand getCoord1()
Gets the first coordinate (i.e. right ascension).- Returns:
- The first coordinate.
-
setCoord1
public final void setCoord1(ADQLOperand coord1)
Sets the first coordinate (i.e. right ascension).- Parameters:
coord1
- The first coordinate.
-
getCoord2
public final ADQLOperand getCoord2()
Gets the second coordinate (i.e. declination).- Returns:
- The second coordinate.
-
setCoord2
public final void setCoord2(ADQLOperand coord2)
Sets the second coordinate (i.e. declination).- Parameters:
coord2
- The second coordinate.
-
getWidth
public final ADQLOperand getWidth()
Gets the width of the box.- Returns:
- The width.
-
setWidth
public final void setWidth(ADQLOperand width)
Sets the width of the box.- Parameters:
width
- The width.
-
getHeight
public final ADQLOperand getHeight()
Gets the height of the box.- Returns:
- The height.
-
setHeight
public final void setHeight(ADQLOperand height)
Sets the height of the box.- Parameters:
height
- The height.
-
getParameters
public ADQLOperand[] 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
public ADQLOperand getParameter(int index) throws java.lang.ArrayIndexOutOfBoundsException
Description copied from class:ADQLFunction
Gets the index-th parameter.- Specified by:
getParameter
in classADQLFunction
- Parameters:
index
- Parameter number.- Returns:
- The corresponding parameter.
- Throws:
java.lang.ArrayIndexOutOfBoundsException
- If the index is incorrect (index < 0 || index >= getNbParameters()).
-
setParameter
public ADQLOperand setParameter(int index, ADQLOperand replacer) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.NullPointerException, java.lang.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:
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.
-
-