Package io.stargate.sdk.doc.domain

Class PageableQuery

java.lang.Object
io.stargate.sdk.doc.domain.PageableQuery
public class PageableQuery extends Object
Build a queyr with filter clause. Designer choice was to use inheritance over composition to simplify builders + genericity is not mandatory.
Author:
Cedrick LUNVEN (@clunven) PageableQuery.builder() .where("age").isGreaterThan(10) // Regular Query .withPageSize(in) // Add Paging

  • Field Details

    • PAGING_SIZE_MAX

      public static final int PAGING_SIZE_MAX
      Limit set for the API.
      See Also:

    • DEFAULT_PAGING_SIZE

      public static final int DEFAULT_PAGING_SIZE
      Number of records to retrieve on a page. MAXIMUM 100.
      See Also:

    • fieldsToRetrieve

      protected Set<String> fieldsToRetrieve
      If we want to filter on fields.

    • where

      protected String where
      Build where clause.

  • Constructor Details

    • PageableQuery

      public PageableQuery(Query query)
      Constructor from super query.
      Parameters:
      query - current query

    • PageableQuery

      public PageableQuery(PageableQueryBuilder builder)
      Constructor hidden to enforce builder usage.
      Parameters:
      builder - filled builder.

  • Method Details

    • builder

      public static PageableQueryBuilder builder()
      static accees to a builder instance
      Returns:
      SearchDocumentQueryBuilder

    • getPageSize

      public int getPageSize()
      Getter accessor for attribute 'pageSize'.
      Returns:
      current value of 'pageSize'

    • getPageState

      public Optional<String> getPageState()
      Getter accessor for attribute 'pageState'.
      Returns:
      current value of 'pageState'

    • setPageState

      public void setPageState(String pageState)
      Setter accessor for attribute 'pageState'.
      Parameters:
      pageState - new value for 'pageState '

    • getWhere

      public Optional<String> getWhere()
      Getter accessor for attribute 'where'.
      Returns:
      current value of 'where'

    • getFieldsToRetrieve

      public Optional<Set<String>> getFieldsToRetrieve()
      Getter accessor for attribute 'fieldsToRetrieve'.
      Returns:
      current value of 'fieldsToRetrieve'