Class LowerFunction
java.lang.Object
adql.query.operand.function.ADQLFunction
adql.query.operand.function.string.LowerFunction
- All Implemented Interfaces:
ADQLObject
,ADQLOperand
It represents the LOWER function of ADQL.
This function converts its string parameter to lower case.
Since case folding is a nontrivial operation in a multi-encoding world, ADQL requires standard behaviour for the ASCII characters, and recommends following algorithm R2 described in Section 3.13, "Default Case Algorithms" of The Unicode Consortium (2012) for characters outside the ASCII set.
Example:
LOWER('Francis Albert Augustus Charles Emmanuel')
which should return:
francis albert augustus charles emmanuel
- Since:
- 2.0
-
Nested Class Summary
Nested classes/interfaces inherited from class adql.query.operand.function.ADQLFunction
ADQLFunction.ParameterIterator
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final String
Constant name of this function.static final LanguageFeature
Description of this ADQL Feature.protected ADQLOperand
The only parameter of this function. -
Constructor Summary
ConstructorsConstructorDescriptionLowerFunction
(ADQLOperand strParam) Builds a LOWER function with its parameter. -
Method Summary
Modifier and TypeMethodDescriptiongetCopy()
Gets a (deep) copy of this ADQL object.final LanguageFeature
Get the description of this ADQL's Language Feature.final String
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.final ADQLOperand[]
Gets the list of all parameters of this function.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
-
Field Details
-
FEATURE
Description of this ADQL Feature.- Since:
- 2.0
-
FCT_NAME
Constant name of this function.- See Also:
-
strParam
The only parameter of this function.
-
-
Constructor Details
-
LowerFunction
Builds a LOWER function with its parameter.- Parameters:
param
- Parameter of LOWER.- Throws:
NullPointerException
- If the given operand is NULL.IllegalArgumentException
- If the operand is not a string parameter.
-
-
Method Details
-
getFeatureDescription
Description copied from interface:ADQLObject
Get the description of this ADQL's Language Feature.Note: Getting this description is generally only useful when discovery optional features so that determining if they are allowed to be used in ADQL queries.
- Returns:
- Description of this ADQL object as an ADQL's feature.
-
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.
-
getName
Description copied from interface:ADQLObject
Gets the name of this object in ADQL.- Returns:
- The name of this ADQL object.
-
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.
-
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.
-
getParameters
Description copied from class:ADQLFunction
Gets the list of all parameters of this function.- Specified by:
getParameters
in classADQLFunction
- Returns:
- Its parameters list.
-
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.
-