Filter.h

/*
     Copyright © CloudBackend AB 2020 - 2023.
*/
 
#ifndef CBE__Filter_h__
#define CBE__Filter_h__
 
#include "cbe/Types.h"
 
#include <iosfwd>
#include <memory>
 
namespace CBI {
class Filter;
class ItemEventProtocol;
using ItemDelegatePtr = std::shared_ptr<ItemEventProtocol>;
} // namespace CBI
 
namespace cbe {
  namespace util {
class Context;
  } // namespace util
  namespace delegate {
class QueryDelegate;
using QueryDelegatePtr = std::shared_ptr<QueryDelegate>;
CBI::ItemDelegatePtr createCbiQueryDelegate(QueryDelegatePtr,
                                            cbe::util::Context&&);
class QueryJoinDelegate;
using QueryJoinDelegatePtr = std::shared_ptr<QueryJoinDelegate>;
CBI::ItemDelegatePtr createCbiQueryDelegate(QueryJoinDelegatePtr,
                                            cbe::util::Context&&);
  } // namespace delegate
 
class Filter {
public:
  Filter();
  Filter(const Filter& rh);
  Filter(Filter&&      rh);
  Filter& operator=(const Filter& rh);
  Filter& operator=(Filter&&      rh);
  ~Filter();
 
  cbe::ItemType getDataType() const;
 
  std::string getQuery() const;
 
  bool getAscending() const;
 
  bool getDeleted() const;
 
  bool getContainerFirst() const;
 
  bool isJoinedResult() const;
 
  std::uint32_t getOffset() const;
 
  std::uint32_t getCount() const;
 
  bool getByPassCache() const;
 
  cbe::FilterOrder getItemOrder() const;
 
  cbe::Container container();
 
  cbe::Filter& setDataType(cbe::ItemType itemType);
 
  cbe::Filter& setQuery(std::string query);
 
  cbe::Filter& setAscending(bool ascending);
 
  cbe::Filter& setDeleted(bool deleted);
 
  cbe::Filter& setContainerFirst(bool containerFirst);
 
  cbe::Filter& setOffset(std::uint32_t offset);
 
  cbe::Filter& setCount(std::uint32_t count);
 
  cbe::Filter& setItemOrder(cbe::FilterOrder order);
 
  cbe::Filter& setByPassCache(bool byPassCache);
 
  friend std::ostream& operator<<(std::ostream& os, const Filter& filter);
private:
  struct Impl;
  std::unique_ptr<Impl> pImpl;
  friend class CloudBackend;
  friend class Container;
  friend class QueryChain;
  friend class QueryResult;
  friend CBI::ItemDelegatePtr delegate::createCbiQueryDelegate(
                                                         delegate::QueryDelegatePtr,
                                                         cbe::util::Context&&);
  friend CBI::ItemDelegatePtr delegate::createCbiQueryDelegate(
                                                         delegate::QueryJoinDelegatePtr,
                                                         cbe::util::Context&&);
  Filter(CBI::Filter&& cbiPeer);
  CBI::Filter& getCbiPeer() const;
}; // class Filter
 
} // namespace cbe
 
 
#endif // #ifndef CBE__Filter_h__