scan_predicate.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
#ifndef KUDU_CLIENT_SCAN_PREDICATE_H
#define KUDU_CLIENT_SCAN_PREDICATE_H

#ifdef KUDU_HEADERS_NO_STUBS
#include "kudu/gutil/macros.h"
#include "kudu/util/slice.h"
#else
#include "kudu/client/stubs.h"
#endif

// NOTE: using stdint.h instead of cstdint because this file is supposed
//       to be processed by a compiler lacking C++11 support.
#include <stdint.h>

#include <cstddef>

#include "kudu/client/hash.h"
#include "kudu/util/kudu_export.h"
#include "kudu/util/status.h"

namespace kudu {
namespace client {

class KUDU_EXPORT KuduPredicate {
 public:
  enum ComparisonOp {
    LESS_EQUAL,
    GREATER_EQUAL,
    EQUAL,
    LESS,
    GREATER,
  };

  ~KuduPredicate();

  KuduPredicate* Clone() const;

  class KUDU_NO_EXPORT Data;

 private:
  friend class ComparisonPredicateData;
  friend class ErrorPredicateData;
  friend class InListPredicateData;
  friend class IsNotNullPredicateData;
  friend class IsNullPredicateData;
  friend class KuduTable;
  friend class ScanConfiguration;

  explicit KuduPredicate(Data* d);

  Data* data_;
  DISALLOW_COPY_AND_ASSIGN(KuduPredicate);
};

class KUDU_EXPORT KuduBloomFilter {
 public:
  ~KuduBloomFilter();

  void Insert(const Slice& key);

 private:
  friend class InBloomFilterPredicateData;
  friend class KuduBloomFilterBuilder;

  class KUDU_NO_EXPORT Data;

  // Owned ptr as per the PIMPL pattern.
  Data* data_;

  KuduBloomFilter* Clone() const;

  KuduBloomFilter();

  explicit KuduBloomFilter(Data* other_data);

  DISALLOW_COPY_AND_ASSIGN(KuduBloomFilter);
};

class KUDU_EXPORT KuduBloomFilterBuilder {
 public:
  explicit KuduBloomFilterBuilder(size_t num_keys);
  ~KuduBloomFilterBuilder();

  KuduBloomFilterBuilder& false_positive_probability(double fpp);

  KuduBloomFilterBuilder& hash_algorithm(HashAlgorithm hash_algorithm);

  KuduBloomFilterBuilder& hash_seed(uint32_t hash_seed);

  Status Build(KuduBloomFilter** bloom_filter);

 private:
  class KUDU_NO_EXPORT Data;

  // Owned ptr as per the PIMPL pattern.
  Data* data_;

  DISALLOW_COPY_AND_ASSIGN(KuduBloomFilterBuilder);
};

} // namespace client
} // namespace kudu
#endif // KUDU_CLIENT_SCAN_PREDICATE_H