GenericIterable.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005 Palmsource, Inc.
 * 
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * are also available at http://www.openbinder.org/license.html.
 * 
 * This software consists of voluntary contributions made by many
 * individuals. For the exact contribution history, see the revision
 * history and logs, available at http://www.openbinder.org
 */

#ifndef _STORAGE_GENERICITERABLE_H
#define _STORAGE_GENERICITERABLE_H

#include <support/IIterable.h>
#include <support/IRandomIterator.h>
#include <support/Locker.h>
#include <support/SortedVector.h>

#if _SUPPORTS_NAMESPACE
namespace palmos {
namespace storage {
using namespace support;
#endif





B_CONST_STRING_VALUE_LARGE(BV_ITERABLE_SELECT,      "select", );


B_CONST_STRING_VALUE_LARGE(BV_ITERABLE_DATABASE,    "database", );


B_CONST_STRING_VALUE_LARGE(BV_ITERABLE_FILTER,      "filter", );


B_CONST_STRING_VALUE_LARGE(BV_ITERABLE_WHERE,       "where", );

B_CONST_STRING_VALUE_SMALL(BV_ITERABLE_WHERE_LHS,   "lhs", );
B_CONST_STRING_VALUE_SMALL(BV_ITERABLE_WHERE_RHS,   "rhs", );
B_CONST_STRING_VALUE_SMALL(BV_ITERABLE_WHERE_OP,    "op", );


B_CONST_STRING_VALUE_LARGE(BV_ITERABLE_ORDER_BY,    "order_by", );

enum {
    B_ORDER_BY_ASCENDING    = 0,
    B_ORDER_BY_DESCENDING   = 1,

    B_ORDER_BY_CASELESS     = 0,
    B_ORDER_BY_CASED        = 2
};


B_CONST_STRING_VALUE_SMALL(BV_ITERABLE_SQL,         "sql", );


// ==========================================================================
// ==========================================================================


class SSQLBuilder
{
public:
    // --------------------------------------------------------------
                                SSQLBuilder();
    virtual                     ~SSQLBuilder();


    // --------------------------------------------------------------

            status_t            BuildSQLString( SString* outSql,
                                                SValue* inoutArgs,
                                                const SString& dbname) const;

            status_t            BuildSQLSubStrings( SString* outSelect,
                                                    SString* outWhere,
                                                    SString* outOrderBy,
                                                    SValue* inoutArgs) const;


    virtual void                MapSQLColumn(SValue* inoutColumn) const;


    virtual void                MapSQLOrderColumn(SValue* inoutColumnName, SValue* inoutOrder) const;


    virtual SValue              CreateSQLFilter(const SValue& filter) const;


private:
                                SSQLBuilder(const SSQLBuilder& o);
            SSQLBuilder&            operator=(const SSQLBuilder& o);
};

// ==========================================================================
// ==========================================================================


class BGenericIterable : public BnIterable, public SSQLBuilder
{
public:
    // --------------------------------------------------------------
                                    BGenericIterable();
                                    BGenericIterable(const SContext& context);
protected:
    virtual                         ~BGenericIterable();
public:



    virtual lock_status_t           Lock() const;

    virtual void                    Unlock() const;


    // ---------------------------------------------------------------------


    virtual sptr<IIterator>         NewIterator(const SValue& args = B_UNDEFINED_VALUE, status_t* error = NULL);

    // ---------------------------------------------------------------------

            class GenericIterator;


    virtual sptr<GenericIterator>   NewGenericIterator(const SValue& args) = 0;


    // --------------------------------------------------------------

    typedef bool                    (*for_each_iterator_func)(  const sptr<BGenericIterable>& iterable,
                                                                const sptr<GenericIterator>& iterator,
                                                                void* cookie);

            void                    ForEachIteratorLocked(for_each_iterator_func func, void* cookie);

            void                    PushIteratorChangedLocked();


private:
                                    BGenericIterable(const BGenericIterable& copyFrom);
                                    BGenericIterable& operator=(const BGenericIterable& copyFrom);

    friend class GenericIterator;

            mutable SLocker         m_lock;
            SSortedVector<wptr<GenericIterator> >
                                    m_iterators;
};

// --------------------------------------------------------------------------


class BGenericIterable::GenericIterator : public BnRandomIterator, public SSQLBuilder
{
public:
    // --------------------------------------------------------------
                                GenericIterator(const SContext& context, const sptr<BGenericIterable>& owner);
protected:
    virtual                     ~GenericIterator();
    virtual void                InitAtom();
    virtual status_t            FinishAtom(const void* id);
public:


    virtual SValue              Inspect(const sptr<IBinder>& caller, const SValue& which, uint32_t flags);
    virtual status_t            StatusCheck() const;

    inline  const sptr<BGenericIterable>&
                                Owner() const { return m_owner; }


    // ---------------------------------------------------------------------


    virtual SValue              Options() const;
    virtual status_t            Next(IIterator::ValueList* keys, IIterator::ValueList* values, uint32_t flags, size_t count);
    virtual status_t            Remove();

    virtual size_t              Count() const;
    virtual size_t              Position() const;
    virtual void                SetPosition(size_t p);


    // ---------------------------------------------------------------------


    virtual void                MapSQLColumn(SValue* inoutColumn) const;
    virtual void                MapSQLOrderColumn(SValue* inoutColumnName, SValue* inoutOrder) const;
    virtual SValue              CreateSQLFilter(const SValue& filter) const;


    // --------------------------------------------------------------


    virtual status_t            ParseArgs(const SValue& args);

    virtual status_t            NextLocked(uint32_t flags, SValue* key, SValue* entry) = 0;

    virtual status_t            RemoveLocked();


private:
            const sptr<BGenericIterable>
                                m_owner;        // this is effectively public.
};

// ==========================================================================
// ==========================================================================

#if _SUPPORTS_NAMESPACE
} } // namespace palmos::storage
#endif

#endif // _STORAGE_GENERICITERABLE_H

---

Generated on Wed Dec 28 22:33:27 2005 by Doxygen 1.4.4 for OpenBinder Documentation Version 1.0

PalmSource, Inc. © 2005