Class Operation

Method Details

• getFeatureDescription

  public final LanguageFeature 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.

  Specified by:

  getFeatureDescription in interface ADQLObject

  Returns:

  Description of this ADQL object as an ADQL's feature.

• getLeftOperand

  public final ADQLOperand getLeftOperand()

  Gets the left part of the operation.

  Returns:

  The left operand.

• setLeftOperand

  public void setLeftOperand(ADQLOperand newLeftOperand) throws NullPointerException, UnsupportedOperationException

  Changes the left operand of this operation.

  Parameters:

  newLeftOperand - The new left operand.

  Throws:

  NullPointerException - If the given operand is NULL.

  UnsupportedOperationException - If the given operand is not numeric (see ADQLOperand.isNumeric()).

• getOperation

  public final OperationType getOperation()

  Gets the operation symbol.

  Returns:

  The operation type.

  See Also:

  • OperationType

• setOperation

  public void setOperation(OperationType newOperation)

  Changes the type of this operation (SUM, SUB, MULT, DIV).

  Parameters:

  newOperation - The new type of this operation.

  See Also:

  • OperationType

• getRightOperand

  public final ADQLOperand getRightOperand()

  Gets the right part of the operation.

  Returns:

  The right operand.

• setRightOperand

  public void setRightOperand(ADQLOperand newRightOperand) throws NullPointerException, UnsupportedOperationException

  Changes the right operand of this operation.

  Parameters:

  newRightOperand - The new right operand of this operation.

  Throws:

  NullPointerException - If the given operand is NULL.

  UnsupportedOperationException - If the given operand is not numeric (see ADQLOperand.isNumeric()).

• isNumeric

  public final boolean isNumeric()

  Always returns true.

  Specified by:

  isNumeric in interface ADQLOperand

  Returns:

  true if this operand is numeric, false otherwise.

  See Also:

  • ADQLOperand.isNumeric()

• isString

  public final boolean isString()

  Always returns false.

  Specified by:

  isString in interface ADQLOperand

  Returns:

  true if this operand is a string, false otherwise.

  See Also:

  • ADQLOperand.isString()

• getPosition

  public final 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).

• setPosition

  public final void setPosition(TextPosition position)

  Sets the position at which this WrappedOperand has been found in the original ADQL query string.

  Parameters:

  position - Position of this WrappedOperand.

  Since:

  1.4

• isGeometry

  public final boolean isGeometry()

  Always returns false.

  Specified by:

  isGeometry in interface ADQLOperand

  Returns:

  true if this operand is a geometry, false otherwise.

  See Also:

  • ADQLOperand.isGeometry()

• getCopy

  public ADQLObject getCopy() throws 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:

  Exception - If there is any error during the copy.

• getName

  public 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 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.