Package adql.query.constraint

Class In

java.lang.Object
adql.query.constraint.In
All Implemented Interfaces:
ADQLObject, ADQLConstraint
public class In extends Object implements ADQLConstraint
It represents the IN predicate of SQL and ADQL.

This predicate returns true if the value of the given operand is either in the given values list or in the results of the given sub-query, else it returns false.

  • Field Details

    • FEATURE

      public static final LanguageFeature FEATURE
      Description of this ADQL Feature.
      Since:
      2.0

  • Constructor Details

    • In

      public In(ADQLOperand op, ADQLSet query) throws NullPointerException
      Builds an IN constraint with a sub-query.
      Parameters:
      op - The operand whose the value must be in the results of the given sub-query.
      query - A sub-query.
      Throws:
      NullPointerException - If the given operand and/or the given sub-query is NULL.

    • In

      public In(ADQLOperand op, ADQLSet query, boolean notIn) throws NullPointerException
      Builds an IN constraint with a sub-query.
      Parameters:
      op - The operand whose the value must be in the results of the given sub-query.
      query - A sub-query.
      notIn - true for NOT IN, false for IN.
      Throws:
      NullPointerException - If the given operand and/or the given sub-query is NULL.

    • In

      public In(ADQLOperand op, ADQLOperand[] valuesList) throws NullPointerException
      Builds an IN constraint with a values list.
      Parameters:
      op - The operand whose the value must be in the given values list.
      valuesList - The values list.
      Throws:
      NullPointerException - If the given operand is NULL and/or the given list is NULL or empty.

    • In

      public In(ADQLOperand op, ADQLOperand[] valuesList, boolean notIn) throws NullPointerException
      Builds an IN constraint with a values list.
      Parameters:
      op - The operand whose the value must be in the given values list.
      valuesList - The values list.
      notIn - true for NOT IN, false for IN.
      Throws:
      NullPointerException - If the given operand is NULL and/or the given list is NULL or empty.

    • In

      public In(ADQLOperand op, ADQLList<ADQLOperand> valuesList) throws NullPointerException
      Builds an IN constraint with a values list.
      Parameters:
      op - The operand whose the value must be in the given values list.
      valuesList - The values list.
      Throws:
      NullPointerException - If the given operand is NULL and/or the given list is NULL or empty.

    • In

      public In(ADQLOperand op, ADQLList<ADQLOperand> valuesList, boolean notIn) throws NullPointerException
      Builds an IN constraint with a values list.
      Parameters:
      op - The operand whose the value must be in the given values list.
      valuesList - The values list.
      notIn - true for NOT IN, false for IN.
      Throws:
      NullPointerException - If the given operand is NULL and/or the given list is NULL or empty.

    • In

      public In(In toCopy) throws Exception
      Builds a IN constraint by copying the given one.
      Parameters:
      toCopy - The IN constraint to copy.
      Throws:
      Exception - If there is an error during the copy.

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

    • getOperand

      public final ADQLOperand getOperand()
      Gets the left operand of this IN constraint.
      Returns:
      Its left operand.

    • setOperand

      public void setOperand(ADQLOperand newLeftOp) throws NullPointerException
      Replaces the left operand of this IN constraint.
      Parameters:
      newLeftOp - Its new left operand.
      Throws:
      NullPointerException - If the given operand is NULL.

    • getSubQuery

      public final ADQLSet getSubQuery()
      Gets the sub-query (right operand) of this IN constraint.
      Returns:
      Its sub-query.

    • hasSubQuery

      public final boolean hasSubQuery()
      Tells whether the right operand of this IN constraint is a sub-query or a values list.
      Returns:
      true if the right operand is a sub-query, false for a values list (even empty).

    • setSubQuery

      public void setSubQuery(ADQLSet newSubQuery) throws NullPointerException
      Replaces the sub-query (right operand) of this IN constraint.
      Parameters:
      newSubQuery - Its new sub-query.
      Throws:
      NullPointerException - If the given sub-query is NULL.

    • getValuesList

      public final ADQLList<ADQLOperand> getValuesList()
      Gets the values list (right operand) of this IN constraint.
      Returns:
      Its values list.

    • setValuesList

      public void setValuesList(ADQLOperand[] valuesList) throws NullPointerException
      Replaces the values list (right operand) of this IN constraint.
      Parameters:
      valuesList - Its new values list.
      Throws:
      NullPointerException - If the given list is NULL.

    • setValuesList

      public void setValuesList(ADQLList<ADQLOperand> valuesList) throws NullPointerException
      Replaces the values list (right operand) of this IN constraint.
      Parameters:
      valuesList - Its new values list.
      Throws:
      NullPointerException - If the given list is NULL.

    • isNotIn

      public final boolean isNotIn()
      Tells whether this predicate is IN or NOT IN.
      Returns:
      true for NOT IN, false for IN.

    • setNotIn

      public void setNotIn(boolean notIn)
      Lets telling whether this predicate must be IN or NOT IN.
      Parameters:
      notIn - true for NOT IN, false for IN.

    • 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)
      Set the position of this In in the given ADQL query string.
      Parameters:
      position - New position of this In.
      Since:
      1.4

    • 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:

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