Package adql.query.operand.function
Class MathFunction
java.lang.Object
adql.query.operand.function.ADQLFunction
adql.query.operand.function.MathFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
It represents any basic mathematical function.
- Version:
- 1.4 (06/2015)
- Author:
- Grégory Mantelet (CDS;ARI)
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
ADQLFunction.ParameterIterator
-
Constructor Summary
ConstructorsConstructorDescriptionMathFunction
(MathFunction toCopy) Builds a mathematical function by copying the given one.Creates a mathematical function without parameter.MathFunction
(MathFunctionType t, ADQLOperand parameter) Creates a mathematical function with only one parameter.MathFunction
(MathFunctionType t, ADQLOperand parameter1, ADQLOperand parameter2) Creates a mathematical function with two parameters. -
Method Summary
Modifier and TypeMethodDescriptiongetCopy()
Gets a (deep) copy of this ADQL object.getName()
Gets the name of this object in ADQL.int
Gets the number of parameters this function has.getParameter
(int index) Gets the index-th parameter.Gets the list of all parameters of this function.final MathFunctionType
getType()
Gets the type of the function (ABS, COS, SIN, ...).final boolean
Tell whether this operand is a geometrical region or not.final boolean
Tell whether this operand is numeric or not.final boolean
isString()
Tell whether this operand is a string or not.setParameter
(int index, ADQLOperand replacer) Replaces the index-th parameter by the given one.Methods inherited from class adql.query.operand.function.ADQLFunction
adqlIterator, getPosition, paramIterator, setPosition, toADQL
-
Constructor Details
-
MathFunction
Creates a mathematical function without parameter.- Parameters:
t
- The type of the function.- Throws:
Exception
- If the given function parameters are incorrect.- See Also:
-
MathFunction
Creates a mathematical function with only one parameter.- Parameters:
t
- The type of the function.parameter
- Its only parameter.- Throws:
Exception
- If the given function parameters are incorrect.- See Also:
-
MathFunction
public MathFunction(MathFunctionType t, ADQLOperand parameter1, ADQLOperand parameter2) throws Exception Creates a mathematical function with two parameters.- Parameters:
t
- The type of the function.parameter1
- Its first parameter.parameter2
- Its second parameter.- Throws:
Exception
- If the given function parameters are incorrect.
-
MathFunction
Builds a mathematical function by copying the given one.- Parameters:
toCopy
- The mathematical function to copy.- Throws:
Exception
- If there is an error during the copy.
-
-
Method Details
-
getType
Gets the type of the function (ABS, COS, SIN, ...).- Returns:
- Its type.
- See Also:
-
getCopy
Description copied from interface:ADQLObject
Gets a (deep) copy of this ADQL object.- Returns:
- The copy of this ADQL object.
- Throws:
Exception
- If there is any error during the copy.
-
getName
Description copied from interface:ADQLObject
Gets the name of this object in ADQL.- Returns:
- The name of this ADQL object.
-
isNumeric
public final 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 final 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 final 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.
-
getParameters
Description copied from class:ADQLFunction
Gets the list of all parameters of this function.- Specified by:
getParameters
in classADQLFunction
- 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 classADQLFunction
- Returns:
- Number of parameters.
-
getParameter
Description copied from class:ADQLFunction
Gets the index-th parameter.- Specified by:
getParameter
in classADQLFunction
- Parameters:
index
- Parameter number.- Returns:
- The corresponding parameter.
- Throws:
ArrayIndexOutOfBoundsException
- If the index is incorrect (index < 0 || index >= getNbParameters()).
-
setParameter
public ADQLOperand setParameter(int index, ADQLOperand replacer) throws ArrayIndexOutOfBoundsException, NullPointerException, Exception Description copied from class:ADQLFunction
Replaces the index-th parameter by the given one.- Specified by:
setParameter
in classADQLFunction
- Parameters:
index
- Index of the parameter to replace.replacer
- The replacer.- Returns:
- The replaced parameter.
- Throws:
ArrayIndexOutOfBoundsException
- If the index is incorrect (index < 0 || index >= getNbParameters()).NullPointerException
- If a required parameter must be replaced by a NULL object.Exception
- If another error occurs.
-