Cell.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_CELL_H
#define HYPERTABLE_CELL_H

#include <iosfwd>
#include "Common/Error.h"
#include "Key.h"

namespace Hypertable {

  class Cell {
  public:
    Cell() : row_key(0), column_family(0), column_qualifier(0),
        timestamp(AUTO_ASSIGN), revision(AUTO_ASSIGN), value(0), value_len(0),
        flag(FLAG_INSERT) { }

    Cell(const char *rk, const char *cf, const char *cq, uint64_t ts,
         uint64_t rev, uint8_t *val, uint32_t vlen, uint8_t flag)
      : row_key(rk), column_family(cf), column_qualifier(cq), timestamp(ts),
        revision(rev), value(val), value_len(vlen), flag(flag) { }

    void sanity_check() const {
      if (!row_key || !*row_key)
        HT_THROW(Error::BAD_KEY, "Invalid row key - cannot be zero length");

      if (row_key[0] == (char)0xff && row_key[1] == (char)0xff)
        HT_THROW(Error::BAD_KEY, "Invalid row key - cannot start with "
                 "character sequence 0xff 0xff");

      if (flag > FLAG_DELETE_ROW && flag < FLAG_INSERT) {
        if (column_family == 0)
          HT_THROWF(Error::BAD_KEY, "Flag is set to %d but column family is null", flag);
        if (flag > FLAG_DELETE_COLUMN_FAMILY && flag < FLAG_INSERT) {
          if (flag == FLAG_DELETE_CELL_VERSION && timestamp == AUTO_ASSIGN)
            HT_THROWF(Error::BAD_KEY, "Flag is set to %d but timestamp is AUTO_ASSIGN", flag);
        }
      }

      if (timestamp == TIMESTAMP_NULL)
        HT_THROWF(Error::BAD_KEY,
                  "Invalid timestamp %lld (reserved for Hypertable use)",
                  (Lld)TIMESTAMP_NULL);
    }

    const char *row_key;
    const char *column_family;
    const char *column_qualifier;
    int64_t timestamp;
    uint64_t revision;
    const uint8_t *value;
    uint32_t value_len;
    uint8_t flag;
  };

  std::ostream &operator<<(std::ostream &, const Cell &);

} // namespace Hypertable

#endif // HYPERTABLE_CELL_H