adql.query.operand.function.geometry

Class GeometryFunction.GeometryValue<F extends GeometryFunction>

java.lang.Object

adql.query.operand.function.geometry.GeometryFunction.GeometryValue<F>

All Implemented Interfaces:

ADQLObject, ADQLOperand

Enclosing class:

GeometryFunction

public static final class GeometryFunction.GeometryValue<F extends GeometryFunction>
extends java.lang.Object
implements ADQLOperand

This class represents a parameter of a geometry function which, in general, is either a GeometryFunction or a Column.

Version:

1.4 (06/2015)

Author:

Grégory Mantelet (CDS;ARI)

Constructor Summary

Constructors

Constructor and Description
GeometryValue(ADQLColumn col)
GeometryValue(F geometry)
GeometryValue(GeometryFunction.GeometryValue<F> toCopy)

Method Summary

Modifier and Type	Method and Description
ADQLIterator	adqlIterator() Gets an iterator on the intern ADQL objects.
ADQLObject	getCopy() Gets a (deep) copy of this ADQL object.
java.lang.String	getName() Gets the name of this object in ADQL.
TextPosition	getPosition() Gets the position of this object/token in the ADQL query.
ADQLOperand	getValue()
boolean	isColumn()
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	setColumn(ADQLColumn col)
void	setGeometry(F geometry)
java.lang.String	toADQL() Gets the ADQL expression of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeometryValue

public GeometryValue(ADQLColumn col)
              throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

GeometryValue

public GeometryValue(F geometry)
              throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

GeometryValue

public GeometryValue(GeometryFunction.GeometryValue<F> toCopy)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

setColumn

public void setColumn(ADQLColumn col)

setGeometry

public void setGeometry(F geometry)

getValue

public ADQLOperand getValue()

isColumn

public boolean isColumn()

isNumeric

public boolean isNumeric()

Description copied from interface: ADQLOperand

Tell whether this operand is numeric or not.

Specified by:

isNumeric in interface ADQLOperand

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.

Specified by:

isString in interface ADQLOperand

Returns:

true if this operand is a string, false otherwise.

getPosition

public TextPosition getPosition()

Description copied from interface: ADQLObject

Gets the position of this object/token in the ADQL query.

By default, no position should be set.

Specified by:

getPosition in interface ADQLObject

Returns:

Position of this ADQL item in the ADQL query, or NULL if not written originally in the query (for example, if added afterwards.

isGeometry

public boolean isGeometry()

Description copied from interface: ADQLOperand

Tell whether this operand is a geometrical region or not.

Specified by:

isGeometry in interface ADQLOperand

Returns:

true if this operand is a geometry, false otherwise.

getCopy

public ADQLObject getCopy()
                   throws java.lang.Exception

Description copied from interface: ADQLObject

Gets a (deep) copy of this ADQL object.

Specified by:

getCopy in interface ADQLObject

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.

Specified by:

getName in interface ADQLObject

Returns:

The name of this ADQL object.

adqlIterator

public ADQLIterator adqlIterator()

Description copied from interface: ADQLObject

Gets an iterator on the intern ADQL objects.

Note:The returned iterator is particularly used by a ISearchHandler extension to browse a whole ADQL tree.

Specified by:

adqlIterator in interface ADQLObject

Returns:

An ADQL objects iterator.

See Also:

ADQLIterator, ISearchHandler

toADQL

public java.lang.String toADQL()

Description copied from interface: ADQLObject

Gets the ADQL expression of this object.

Specified by:

toADQL in interface ADQLObject

Returns:

The corresponding ADQL expression.