AccessGroupSpec.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 3 of the
 * License, or any later version.
 *
 * Hypertable is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */


#ifndef Hypertable_Lib_AccessGroupSpec_h
#define Hypertable_Lib_AccessGroupSpec_h

#include <Hypertable/Lib/ColumnFamilySpec.h>

#include <Common/Properties.h>

#include <bitset>
#include <unordered_map>
#include <vector>

namespace Hypertable {


  enum BloomFilterMode {
    BLOOM_FILTER_DISABLED,
    BLOOM_FILTER_ROWS,
    BLOOM_FILTER_ROWS_COLS
  };

  class AccessGroupOptions {
  public:

    enum {
      REPLICATION,
      BLOCKSIZE,
      COMPRESSOR,
      BLOOMFILTER,
      IN_MEMORY,
      MAX
    };

    void set_replication(int16_t replication);

    int16_t get_replication() const { return m_replication; }

    bool is_set_replication() const;

    void set_blocksize(int32_t blocksize);

    int32_t get_blocksize() const { return m_blocksize; }

    bool is_set_blocksize() const;

    void set_compressor(const std::string &compressor);

    const std::string &get_compressor() const { return m_compressor; }

    bool is_set_compressor() const;

    void set_bloom_filter(const std::string &bloomfilter);

    const std::string &get_bloom_filter() const { return m_bloomfilter; }

    bool is_set_bloom_filter() const;

    void set_in_memory(bool value);

    bool get_in_memory() const { return m_in_memory; }

    bool is_set_in_memory() const;

    void merge(const AccessGroupOptions &other);

    void parse_xml(const char *base, int len);

    const std::string render_xml(const std::string &line_prefix) const;

    const std::string render_hql() const;

    static void parse_bloom_filter(const std::string &spec, PropertiesPtr &props);

    bool operator==(const AccessGroupOptions &other) const;

  private:

    int16_t m_replication {-1};

    int32_t m_blocksize {};
    
    std::string m_compressor;

    std::string m_bloomfilter;

    bool m_in_memory {};

    std::bitset<MAX> m_isset;
  };

  class AccessGroupSpec {
  public:

    AccessGroupSpec() { }

    AccessGroupSpec(const std::string &name) : m_name(name) { }

    ~AccessGroupSpec();

    void set_name(const std::string &name);

    const std::string &get_name() const { return m_name; }

    void set_generation(int64_t generation) { m_generation = generation; }

    void clear_generation() { m_generation = 0; }

    bool clear_generation_if_changed(AccessGroupSpec &original);

    int64_t get_generation() const { return m_generation; }

    void set_option_replication(int16_t replication);

    int16_t get_option_replication() const;

    void set_option_blocksize(int32_t blocksize);

    int32_t get_option_blocksize() const;

    void set_option_compressor(const std::string &compressor);

    const std::string get_option_compressor() const;

    void set_option_bloom_filter(const std::string &bloomfilter);

    const std::string &get_option_bloom_filter() const;

    void set_option_in_memory(bool value);

    bool get_option_in_memory() const;

    void set_default_max_versions(int32_t max_versions);

    int32_t get_default_max_versions() const;

    void set_default_ttl(time_t ttl);

    time_t get_default_ttl() const;

    void set_default_time_order_desc(bool value);

    bool get_default_time_order_desc() const;

    void set_default_counter(bool value);

    bool get_default_counter() const;

    void add_column(ColumnFamilySpec *cf);

    ColumnFamilySpec *replace_column(ColumnFamilySpec *new_cf);

    ColumnFamilySpec *remove_column(const std::string &name);

    void drop_column(const std::string &name);

    ColumnFamilySpec *get_column(const std::string &name);

    void clear_columns() { m_columns.clear(); }

    void merge_options(const AccessGroupOptions &options) {
      m_options.merge(options);
    }

    void merge_defaults(const ColumnFamilyOptions &options) {
      m_defaults.merge(options);
    }

    bool operator==(const AccessGroupSpec &other) const;

    void parse_xml(const char *base, int len);

    const std::string render_xml(const std::string &line_prefix,
                                 bool with_ids=false) const;

    const std::string render_hql() const;

    ColumnFamilySpecs &columns() { return m_columns; }

    const AccessGroupOptions &options() const { return m_options; }

    const ColumnFamilyOptions &defaults() const { return m_defaults; }

  private:

    std::string m_name;

    int64_t m_generation {};

    AccessGroupOptions m_options;

    ColumnFamilyOptions m_defaults;

    ColumnFamilySpecs m_columns;
  };

  typedef std::vector<AccessGroupSpec *> AccessGroupSpecs;


} // namespace Hypertable

#endif // Hypertable_Lib_AccessGroup_h