Package com.sap.cds.ql.cqn

Interface CqnSelect

All Superinterfaces:
CqnEntitySelector, CqnFilterableStatement, CqnSource, CqnStatement, CqnToken, JSONizable
All Known Implementing Classes:
Select
public interface CqnSelect extends CqnFilterableStatement, CqnEntitySelector, CqnSource

  • Method Details

    • from

      CqnSource from()
      The from clause of this select statement.
      Returns:
      a reference to this statement's CqnSource

    • isDistinct

      boolean isDistinct()
      Returns:
      whether statement is a SELECT DISTINCT

    • columns

      @Deprecated default List<CqnSelectListItem> columns()
      Deprecated.
      instead use CqnEntitySelector.items()
      Returns:
      the select list items

    • groupBy

      List<CqnValue> groupBy()

    • excluding

      List<String> excluding()

    • having

      Optional<CqnPredicate> having()

    • getLock

      Optional<CqnLock> getLock()

    • search

      Optional<CqnPredicate> search()

    • transformations

      @Beta List<CqnTransformation> transformations()
      Returns the pipeline of transformations, which is applied to the source ref of this select statement before the the regular clauses are applied. The statement is processed in this order:
      1. ref, source
      2. transformations
      3. where, search
      4. groupBy
      5. having
      6. items, distinct
      7. orderBy
      8. skip
      9. top
      Returns:
      the pipeline of transformations

    • isSelect

      default boolean isSelect()
      Description copied from interface: CqnStatement
      Returns true if this is a CqnSelect statement.
      Specified by:
      isSelect in interface CqnSource
      Specified by:
      isSelect in interface CqnStatement
      Returns:
      true if this is a select statement, otherwise false

    • asSelect

      default CqnSelect asSelect()
      Description copied from interface: CqnStatement
      Casts this CQN statement to CqnSelect.
      Specified by:
      asSelect in interface CqnSource
      Specified by:
      asSelect in interface CqnStatement
      Returns:
      this statement as a CqnSelect

    • accept

      default void accept(CqnVisitor visitor)
      Traverses the clauses of this CqnSelect with a given visitor. If the source of this select is a structured type reference it is visited first. The other clauses are traversed depth-first in the following order:
      • items
      • where
      • search
      • group by
      • having
      • order by
      Afterwards this CqnSelect is passed to the CqnVisitor.visit(CqnSelect) method.
      Specified by:
      accept in interface CqnToken
      Parameters:
      visitor - the CqnVisitor

    • dispatch

      default void dispatch(CqnVisitor visitor)
      Description copied from interface: CqnEntitySelector
      Dispatches a given visitor to all clause except the ref or source of this entity selector
      Specified by:
      dispatch in interface CqnEntitySelector
      Parameters:
      visitor - the visitor