Package adql.query.operand
Class NegativeOperand
java.lang.Object
adql.query.operand.NegativeOperand
- All Implemented Interfaces:
ADQLObject,ADQLOperand
Lets putting a minus sign in front of any numeric operand.
- Version:
- 1.4 (09/2017)
- Author:
- Grégory Mantelet (CDS;ARI)
-
Constructor Summary
ConstructorsConstructorDescriptionNegativeOperand(ADQLOperand operand) Builds an operand which will negativate the given operand. -
Method Summary
Modifier and TypeMethodDescriptionGets an iterator on the intern ADQL objects.getCopy()Gets a (deep) copy of this ADQL object.getName()Gets the name of this object in ADQL.final ADQLOperandGets the operand on which the minus sign is applied.final TextPositionGets the position of this object/token in the ADQL query.final booleanAlways returns false.final booleanAlways returns true.final booleanisString()Always returns false.final voidsetPosition(TextPosition position) Sets the position at which thisNegativeOperandhas been found in the original ADQL query string.toADQL()Gets the ADQL expression of this object.
-
Constructor Details
-
NegativeOperand
public NegativeOperand(ADQLOperand operand) throws NullPointerException, UnsupportedOperationException Builds an operand which will negativate the given operand.
Important: The given operand must be numeric (
ADQLOperand.isNumeric()must return true) !- Parameters:
operand- The operand to negativate.- Throws:
NullPointerException- If the given operand is null.UnsupportedOperationException- If the given operand is not numeric (ifADQLOperand.isNumeric()does not return true).
-
-
Method Details
-
getOperand
Gets the operand on which the minus sign is applied.- Returns:
- The negativated operand.
-
isNumeric
public final boolean isNumeric()Always returns true.- Specified by:
isNumericin interfaceADQLOperand- Returns:
- true if this operand is numeric, false otherwise.
- See Also:
-
isString
public final boolean isString()Always returns false.- Specified by:
isStringin interfaceADQLOperand- Returns:
- true if this operand is a string, false otherwise.
- See Also:
-
getPosition
Description copied from interface:ADQLObjectGets the position of this object/token in the ADQL query.
By default, no position should be set.
- Specified by:
getPositionin interfaceADQLObject- Returns:
- Position of this ADQL item in the ADQL query, or NULL if not written originally in the query (for example, if added afterwards.
-
setPosition
Sets the position at which thisNegativeOperandhas been found in the original ADQL query string.- Parameters:
position- Position of thisNegativeOperand.- Since:
- 1.4
-
isGeometry
public final boolean isGeometry()Always returns false.- Specified by:
isGeometryin interfaceADQLOperand- Returns:
- true if this operand is a geometry, false otherwise.
- See Also:
-
getCopy
Description copied from interface:ADQLObjectGets a (deep) copy of this ADQL object.- Specified by:
getCopyin interfaceADQLObject- Returns:
- The copy of this ADQL object.
- Throws:
Exception- If there is any error during the copy.
-
getName
Description copied from interface:ADQLObjectGets the name of this object in ADQL.- Specified by:
getNamein interfaceADQLObject- Returns:
- The name of this ADQL object.
-
adqlIterator
Description copied from interface:ADQLObjectGets an iterator on the intern ADQL objects.
Note:The returned iterator is particularly used by a
ISearchHandlerextension to browse a whole ADQL tree.- Specified by:
adqlIteratorin interfaceADQLObject- Returns:
- An ADQL objects iterator.
- See Also:
-
toADQL
Description copied from interface:ADQLObjectGets the ADQL expression of this object.- Specified by:
toADQLin interfaceADQLObject- Returns:
- The corresponding ADQL expression.
-