ColumnFamilySpec.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_ColumnFamilySpec_h
#define Hypertable_Lib_ColumnFamilySpec_h

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

namespace Hypertable {


  class ColumnFamilyOptions {
  public:

    enum {
      MAX_VERSIONS,
      TTL,
      TIME_ORDER_DESC,
      COUNTER,
      MAX
    };

    bool set_max_versions(int32_t max_versions);

    int32_t get_max_versions() const { return m_max_versions; }

    bool is_set_max_versions() const;

    bool set_ttl(time_t ttl);

    time_t get_ttl() const { return m_ttl; }

    bool is_set_ttl() const;

    bool set_time_order_desc(bool value);

    bool get_time_order_desc() const { return m_time_order_desc; }

    bool is_set_time_order_desc() const;

    bool set_counter(bool value);

    bool get_counter() const { return m_counter; }

    bool is_set_counter() const;

    void merge(const ColumnFamilyOptions &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;

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

  private:

    int32_t m_max_versions {};

    time_t m_ttl {};

    bool m_time_order_desc {};

    bool m_counter {};

    std::bitset<MAX> m_isset;
  };

  class ColumnFamilySpec {
  public:

    ColumnFamilySpec() { }

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

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

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

    void set_access_group(const std::string &ag);

    const std::string &get_access_group() const { return m_ag; }

    void set_generation(int64_t generation);

    int64_t get_generation() const { return m_generation; }

    void set_id(int32_t id);

    int32_t get_id() const { return m_id; }

    void set_value_index(bool value);

    bool get_value_index() const { return m_value_index; }

    void set_qualifier_index(bool value);

    bool get_qualifier_index() const { return m_qualifier_index; }

    void set_deleted(bool value);

    bool get_deleted() const { return m_deleted; }

    void set_option_max_versions(int32_t max_versions);

    int32_t get_option_max_versions() const {
      return m_options.get_max_versions();
    }

    void set_option_ttl(time_t ttl);

    time_t get_option_ttl() const { return m_options.get_ttl(); }

    void set_option_time_order_desc(bool value);

    bool get_option_time_order_desc() const {
      return m_options.get_time_order_desc();
    }

    void set_option_counter(bool value);

    bool get_option_counter() const { return m_options.get_counter(); }

    void merge_options(const ColumnFamilyOptions &other);

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

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

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

    const std::string render_hql() const;

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

  private:

    std::string m_name;
    
    std::string m_ag;

    int64_t m_generation {};

    int32_t m_id {};

    ColumnFamilyOptions m_options;

    bool m_value_index {};

    bool m_qualifier_index {};

    bool m_deleted {};
  };

  typedef std::vector<ColumnFamilySpec *> ColumnFamilySpecs;


} // namespace Hypertable

#endif // Hypertable_Lib_ColumnFamily_h