ADQLObject
, ADQLOperand
GeometryFunction
, MathFunction
, SQLFunction
, UserDefinedFunction
public abstract class ADQLFunction extends java.lang.Object implements ADQLOperand
Modifier and Type | Class | Description |
---|---|---|
protected class |
ADQLFunction.ParameterIterator |
Lets iterating on all parameters of the given function.
|
Constructor | Description |
---|---|
ADQLFunction() |
Modifier and Type | Method | Description |
---|---|---|
ADQLIterator |
adqlIterator() |
Gets an iterator on the intern ADQL objects.
|
abstract int |
getNbParameters() |
Gets the number of parameters this function has.
|
abstract ADQLOperand |
getParameter(int index) |
Gets the index-th parameter.
|
abstract ADQLOperand[] |
getParameters() |
Gets the list of all parameters of this function.
|
TextPosition |
getPosition() |
Gets the position of this object/token in the ADQL query.
|
java.util.Iterator<ADQLOperand> |
paramIterator() |
Creates an iterator on the parameters of this function.
|
abstract ADQLOperand |
setParameter(int index,
ADQLOperand replacer) |
Replaces the index-th parameter by the given one.
|
void |
setPosition(TextPosition position) |
Set the position of this
ADQLFunction in the ADQL query string. |
java.lang.String |
toADQL() |
Gets the ADQL expression of this object.
|
getCopy, getName
isGeometry, isNumeric, isString
public final TextPosition getPosition()
ADQLObject
Gets the position of this object/token in the ADQL query.
By default, no position should be set.
getPosition
in interface ADQLObject
public final void setPosition(TextPosition position)
ADQLFunction
in the ADQL query string.position
- New position of this ADQLFunction
public abstract int getNbParameters()
public abstract ADQLOperand[] getParameters()
public abstract ADQLOperand getParameter(int index) throws java.lang.ArrayIndexOutOfBoundsException
index
- Parameter number.java.lang.ArrayIndexOutOfBoundsException
- If the index is incorrect (index < 0 || index >= getNbParameters()).public abstract ADQLOperand setParameter(int index, ADQLOperand replacer) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.NullPointerException, java.lang.Exception
index
- Index of the parameter to replace.replacer
- The replacer.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.public java.util.Iterator<ADQLOperand> paramIterator()
public ADQLIterator adqlIterator()
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.
adqlIterator
in interface ADQLObject
ADQLIterator
,
ISearchHandler
public java.lang.String toADQL()
ADQLObject
toADQL
in interface ADQLObject