adql.query.operand.function.geometry

Class DistanceFunction

java.lang.Object

adql.query.operand.function.ADQLFunction

adql.query.operand.function.geometry.GeometryFunction

adql.query.operand.function.geometry.DistanceFunction

All Implemented Interfaces:

ADQLObject, ADQLOperand

public class DistanceFunction
extends GeometryFunction

It represents the DISTANCE function of the ADQL language.

This function computes the arc length along a great circle between two points, and returns a numeric value expression in degrees.

Example:
DISTANCE(POINT('ICRS GEOCENTER', 25.0, -19.5), POINT('ICRS GEOCENTER', 25.4, -20.0))
In this example the function computes the distance between two points of coordinates (25, -19.5) and (25.4, -20) both expressed according to the ICRS 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

Fields inherited from class adql.query.operand.function.geometry.GeometryFunction

coordSys

Constructor Summary

Constructors

Constructor and Description
DistanceFunction(DistanceFunction toCopy) Builds a DISTANCE function by copying the given one.
DistanceFunction(GeometryFunction.GeometryValue<PointFunction> point1, GeometryFunction.GeometryValue<PointFunction> point2) Builds a DISTANCE function.

Method Summary

Modifier and Type	Method and Description
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.
GeometryFunction.GeometryValue<PointFunction>	getP1() Gets the first point.
GeometryFunction.GeometryValue<PointFunction>	getP2() Gets the second point.
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	setCoordinateSystem(ADQLOperand coordSys) Changes the coordinate system.
void	setP1(GeometryFunction.GeometryValue<PointFunction> p1) Sets the first point.
void	setP2(GeometryFunction.GeometryValue<PointFunction> p2) Sets the second point.
ADQLOperand	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

Methods inherited from class adql.query.operand.function.ADQLFunction

adqlIterator, getPosition, paramIterator, setPosition, toADQL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DistanceFunction

public DistanceFunction(GeometryFunction.GeometryValue<PointFunction> point1,
                        GeometryFunction.GeometryValue<PointFunction> point2)
                 throws java.lang.NullPointerException

Builds a DISTANCE function.

Parameters:

point1 - The first point.

point2 - The second point.

Throws:

java.lang.NullPointerException - If one of the parameters are incorrect.

DistanceFunction

public DistanceFunction(DistanceFunction toCopy)
                 throws java.lang.Exception

Builds a DISTANCE function by copying the given one.

Parameters:

toCopy - The DISTANCE function to copy.

Throws:

java.lang.Exception - If there is an error during the copy.

Method Detail

setCoordinateSystem

public void setCoordinateSystem(ADQLOperand coordSys)
                         throws java.lang.UnsupportedOperationException

Description copied from class: GeometryFunction

Changes the coordinate system.

Overrides:

setCoordinateSystem in class GeometryFunction

Parameters:

coordSys - Its new coordinate system.

Throws:

java.lang.UnsupportedOperationException - If this function is not associated with a coordinate system.

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.

getP1

public final GeometryFunction.GeometryValue<PointFunction> getP1()

Gets the first point.

Returns:

A point.

setP1

public final void setP1(GeometryFunction.GeometryValue<PointFunction> p1)

Sets the first point.

Parameters:

p1 - A point.

getP2

public final GeometryFunction.GeometryValue<PointFunction> getP2()

Gets the second point.

Returns:

A point.

setP2

public final void setP2(GeometryFunction.GeometryValue<PointFunction> p2)

Sets the second point.

Parameters:

p2 - A point.

getParameters

public ADQLOperand[] getParameters()

Description copied from class: ADQLFunction

Gets the list of all parameters of this function.

Specified by:

getParameters in class ADQLFunction

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 class ADQLFunction

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 class ADQLFunction

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 class ADQLFunction

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.