collection.hh

Go to the documentation of this file.

/*
* This file is part of rasdaman community.
*
* Rasdaman community 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, either version 3 of the License, or
* (at your option) any later version.
*
* Rasdaman community 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 rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*/
 
#ifndef _D_COLLECTION_
#define _D_COLLECTION_
 
#include "rasodmg/object.hh"
 
template <class T>
class r_Iterator;
 
//@ManMemo: Module: {\bf rasodmg}
template <class T>
class r_Collection : public r_Object
{
    friend class r_Iterator<T>;
 
public:
    r_Collection();
    r_Collection(const r_Collection<T> &collection);
    virtual ~r_Collection();
 
    virtual void r_deactivate();
 
    unsigned long cardinality() const;
 
    bool is_empty() const;
    bool is_ordered() const;
    bool allows_duplicates() const;
 
    bool contains_element(const T &element) const;
    virtual void insert_element(const T &element, int no_modification = 0);
    virtual void remove_element(const T &element);
    void remove_all();
 
    const r_Collection<T> &operator=(const r_Collection<T> &collection);
 
    r_Iterator<T> create_iterator();
 
    const r_Type *get_element_type_schema();
 
    //@Man: Methods for database communication (internal use only):
 
 
    virtual void insert_obj_into_db();
 
    virtual void insert_obj_into_db(const char *)
    {
        ;
    };
    virtual void update_obj_in_db();
 
 
 
protected:
    struct CNode
    {
        CNode *next;
        T *elem;
    };
 
    //@Man: Methods/Attributes for maintainance of removed objects
 
 
    r_Iterator<T> create_removed_iterator();
 
    CNode *removed_objects;
 
 
 
    //@Man: Attributes storing some state information
 
    int isOrdered;
    int allowsDuplicates;
    unsigned long card;
 
 
    // Normally, we would have used the following class to implement the
    // internal structure of a r_Collection. But for RPC's sake, we use
    // a simple structure. (RPC is not able to transfer C++ objects.)
    //
    // template <class T>
    // class CNode
    // {
    //  public:
    //    CNode();
    //    CNode( const CNode& cnode );
    //    ~CNode();
    //
    //    inline CNode* get_next() const;
    //    inline void set_next( const CNode& cnode );
    //    inline T* get_elem() const;
    //    inline void set_elem( const T& element);
    //
    //  private:
    //    CNode* next;
    //    T* elem;
    // }
 
    //@Man: Methods for manipulating CNode lists
 
 
    void add_node(CNode *&root, const T &element);
    bool remove_node(CNode *&root, const T &element);
    void remove_all_nodes(CNode *&root);
    void init_node_list(CNode *&root);
 
 
 
    CNode *coll;
};
 
class r_GMarray;
extern template class r_Collection<r_GMarray *>;
class r_Ref_Any;
extern template class r_Collection<r_Ref_Any>;
 
template <typename T>
class r_Ref;
class r_Object;
extern template class r_Collection<r_Ref<r_Object>>;
extern template class r_Collection<r_Ref<r_GMarray>>;
 
struct GenRefElement;
extern template class r_Collection<GenRefElement *>;
 
#endif