Package adql.query

Class SelectAllColumns

java.lang.Object
adql.query.SelectItem
adql.query.SelectAllColumns
All Implemented Interfaces:
ADQLObject
public final class SelectAllColumns extends SelectItem
In ADQL it corresponds to the * and {tableName}.* items in the SELECT clause. It means: 'select all columns'.

  • Field Details

    • FEATURE

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

  • Constructor Details

    • SelectAllColumns

      public SelectAllColumns(ADQLQuery query)
      Builds a SelectItem which selects all columns available in the given ADQL query.
      Parameters:
      query - The query whose all available columns must be selected.

    • SelectAllColumns

      public SelectAllColumns(ADQLTable table)
      Builds a SelectItem which selects all columns available in the given table.
      Parameters:
      table - The table whose all available columns must be selected.

    • SelectAllColumns

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

  • Method Details

    • getFeatureDescription

      public 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
      Overrides:
      getFeatureDescription in class SelectItem
      Returns:
      Description of this ADQL object as an ADQL's feature.

    • getQuery

      public final ADQLQuery getQuery()
      Gets the query whose all available columns must be selected.
      Returns:
      The ADQL query whose all available columns must be selected, or NULL if the selection does not concern an ADQLQuery but an ADQLTable.

    • setQuery

      public final void setQuery(ADQLQuery query)
      Sets the query whose all available columns must be selected.
      Parameters:
      query - An ADQLQuery (MUST NOT BE NULL).

    • getAdqlTable

      public final ADQLTable getAdqlTable()
      Gets the table whose all columns must be selected.
      Returns:
      The ADQL table whose all columns must be selected, or NULL if the selection does not concern an ADQLTable but an ADQLQuery.

    • setAdqlTable

      public final void setAdqlTable(ADQLTable table)
      Sets the table whose all columns must be selected.
      Parameters:
      table - An ADQLTable (MUST NOT BE NULL).

    • getCopy

      public final ADQLObject getCopy() throws Exception
      Description copied from interface: ADQLObject
      Gets a (deep) copy of this ADQL object.
      Specified by:
      getCopy in interface ADQLObject
      Overrides:
      getCopy in class SelectItem
      Returns:
      The copy of this ADQL object.
      Throws:
      Exception - If there is any error during the copy.

    • getName

      public final String getName()
      Description copied from interface: ADQLObject
      Gets the name of this object in ADQL.
      Specified by:
      getName in interface ADQLObject
      Overrides:
      getName in class SelectItem
      Returns:
      The name of this ADQL object.

    • adqlIterator

      public final 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
      Overrides:
      adqlIterator in class SelectItem
      Returns:
      An ADQL objects iterator.
      See Also:

    • toADQL

      public final String toADQL()
      Description copied from interface: ADQLObject
      Gets the ADQL expression of this object.
      Specified by:
      toADQL in interface ADQLObject
      Overrides:
      toADQL in class SelectItem
      Returns:
      The corresponding ADQL expression.