Class GeometryFunction
java.lang.Object
adql.query.operand.function.ADQLFunction
adql.query.operand.function.geometry.GeometryFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
- Direct Known Subclasses:
AreaFunction
,BoxFunction
,CentroidFunction
,CircleFunction
,ContainsFunction
,DistanceFunction
,ExtractCoord
,ExtractCoordSys
,IntersectsFunction
,PointFunction
,PolygonFunction
,RegionFunction
It represents any geometric function of ADQL.
For historical reasons, the geometry regions accept an optional string value as the first argument. As of this version of the specification (2.1) this parameter has been marked as deprecated. Future versions of this specification (>2.1) may remove this parameter.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
This class represents a parameter of a geometry function which, in general, is either a GeometryFunction or an UnknownType operand (e.g.Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
ADQLFunction.ParameterIterator
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Builds a geometry function with no coordinate system.protected
GeometryFunction
(ADQLOperand coordSys) Deprecated.Since ADQL-2.1, the coordinate system argument is deprecated.protected
GeometryFunction
(GeometryFunction toCopy) Builds a geometry function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Since ADQL-2.1.void
setCoordinateSystem
(ADQLOperand coordSys) Deprecated.Since ADQL-2.1.Methods inherited from class adql.query.operand.function.ADQLFunction
adqlIterator, getNbParameters, getParameter, getParameters, getPosition, paramIterator, setParameter, setPosition, toADQL
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface adql.query.ADQLObject
getCopy, getFeatureDescription, getName
Methods inherited from interface adql.query.operand.ADQLOperand
isGeometry, isNumeric, isString
-
Field Details
-
coordSys
Deprecated.Since ADQL-2.1.The coordinate system used to express the coordinates.
-
-
Constructor Details
-
GeometryFunction
protected GeometryFunction()Builds a geometry function with no coordinate system. -
GeometryFunction
@Deprecated protected GeometryFunction(ADQLOperand coordSys) throws UnsupportedOperationException, NullPointerException, Exception Deprecated.Since ADQL-2.1, the coordinate system argument is deprecated.Builds a geometry function with its coordinate system.- Parameters:
coordSys
- A string operand which corresponds to a valid coordinate system.- Throws:
UnsupportedOperationException
- If this function is not associated with a coordinate system.NullPointerException
- If the given operand is NULL.Exception
- If the given operand is not a string.
-
GeometryFunction
Builds a geometry function by copying the given one.- Parameters:
toCopy
- The geometry function to copy.- Throws:
Exception
- If there is an error during the copy.
-
-
Method Details
-
getCoordinateSystem
Deprecated.Since ADQL-2.1.Gets the used coordinate system.- Returns:
- Its coordinate system.
-
setCoordinateSystem
@Deprecated public void setCoordinateSystem(ADQLOperand coordSys) throws UnsupportedOperationException, NullPointerException, ParseException Deprecated.Since ADQL-2.1.Changes the coordinate system.- Parameters:
coordSys
- Its new coordinate system.- Throws:
UnsupportedOperationException
- If this function is not associated with a coordinate system.NullPointerException
- If the given operand is NULL.ParseException
- If the given operand is not a string.
-