QCassandraRow.h

Go to the documentation of this file.

/*
 * Header:
 *      QCassandraRow.h
 *
 * Description:
 *      Handling of a row to access colunms within that row.
 *
 * Documentation:
 *      See the corresponding .cpp file.
 *
 * License:
 *      Copyright (c) 2011 Made to Order Software Corp.
 * 
 *      http://snapwebsites.org/
 *      contact@m2osw.com
 * 
 *      Permission is hereby granted, free of charge, to any person obtaining a
 *      copy of this software and associated documentation files (the
 *      "Software"), to deal in the Software without restriction, including
 *      without limitation the rights to use, copy, modify, merge, publish,
 *      distribute, sublicense, and/or sell copies of the Software, and to
 *      permit persons to whom the Software is furnished to do so, subject to
 *      the following conditions:
 *
 *      The above copyright notice and this permission notice shall be included
 *      in all copies or substantial portions of the Software.
 *
 *      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *      OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *      MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *      IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *      CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *      TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 *      SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef QCASSANDRA_ROW_H
#define QCASSANDRA_ROW_H

#include "QCassandraCell.h"
#include "QCassandraColumnPredicate.h"

namespace QtCassandra
{

class QCassandraTable;

// Cassandra Row
class QCassandraRow : public QObject
{
public:
    virtual ~QCassandraRow();

    QString rowName() const;
    const QByteArray& rowKey() const;

    int cellCount(const QCassandraColumnPredicate& column_predicate = QCassandraColumnPredicate());
    void readCells(const QCassandraColumnPredicate& column_predicate = QCassandraColumnPredicate());

    QSharedPointer<QCassandraCell> cell(const QString& column_name);
    QSharedPointer<QCassandraCell> cell(const QByteArray& column_key);
    const QCassandraCells& cells() const;

    QSharedPointer<QCassandraCell> findCell(const QString& column_name) const;
    QSharedPointer<QCassandraCell> findCell(const QByteArray& column_key) const;
    bool exists(const QString& column_name) const;
    bool exists(const QByteArray& column_key) const;
    QCassandraCell& operator [] (const QString& column_name);
    QCassandraCell& operator [] (const QByteArray& column_key);
    const QCassandraCell& operator [] (const QString& column_name) const;
    const QCassandraCell& operator [] (const QByteArray& column_key) const;

    void clearCache();

    void dropCell(const QByteArray& column_key, QCassandraValue::timestamp_mode_t mode = QCassandraValue::TIMESTAMP_MODE_AUTO, int64_t timestamp = 0);
    void dropCell(const QString& column_name, QCassandraValue::timestamp_mode_t mode = QCassandraValue::TIMESTAMP_MODE_AUTO, int64_t timestamp = 0);

private:
    QCassandraRow(QCassandraTable *table, const QByteArray& row_key);

    void insertValue(const QByteArray& column_key, const QCassandraValue& value);
    void getValue(const QByteArray& column_key, QCassandraValue& value);
    void unparent();

    friend class QCassandraTable;
    friend class QCassandraCell;

    // f_table is a parent that has a strong shared pointer over us so it
    // cannot disappear before we do, thus only a bare pointer is enough here
    // (there isn't a need to use a QWeakPointer or QPointer either)
    QCassandraTable *       f_table;
    QByteArray              f_key;
    QCassandraCells         f_cells;
};

// array of rows
typedef QMap<QByteArray, QSharedPointer<QCassandraRow> > QCassandraRows;



} // namespace QtCassandra
#endif
//#ifndef QCASSANDRA_ROW_H
// vim: ts=4 sw=4 et