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.
- Version:
- 1.4 (06/2015)
- Author:
- Grégory Mantelet (CDS;ARI)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThis class represents a parameter of a geometry function which, in general, is either a GeometryFunction or a Column.Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
ADQLFunction.ParameterIterator -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ADQLOperandThe coordinate system used to express the coordinates. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBuilds a geometry function with no coordinate system.protectedGeometryFunction(ADQLOperand coordSys) Builds a geometry function with its coordinate system.protectedGeometryFunction(GeometryFunction toCopy) Builds a geometry function by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptionGets the used coordinate system.voidsetCoordinateSystem(ADQLOperand coordSys) Changes the coordinate system.Methods inherited from class adql.query.operand.function.ADQLFunction
adqlIterator, getNbParameters, getParameter, getParameters, getPosition, paramIterator, setParameter, setPosition, toADQLMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface adql.query.ADQLObject
getCopy, getNameMethods inherited from interface adql.query.operand.ADQLOperand
isGeometry, isNumeric, isString
-
Field Details
-
coordSys
The coordinate system used to express the coordinates.
-
-
Constructor Details
-
GeometryFunction
protected GeometryFunction()Builds a geometry function with no coordinate system. -
GeometryFunction
protected GeometryFunction(ADQLOperand coordSys) throws UnsupportedOperationException, NullPointerException, Exception 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
Gets the used coordinate system.- Returns:
- Its coordinate system.
-
setCoordinateSystem
public void setCoordinateSystem(ADQLOperand coordSys) throws UnsupportedOperationException, NullPointerException, ParseException 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.
-