database.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_DATABASE_
#define _D_DATABASE_
 
#include "raslib/mddtypes.hh"
#include "globals.hh"
#include <string>
 
// forward declarations
class r_Object;
class r_OId;
class r_Type;
class r_Ref_Any;
class ClientComm;
 
//@ManMemo: Module: {\bf rasodmg}
 
class r_Database
{
public:
    enum access_status
    {
        not_open,
        read_write,
        read_only,
        exclusive
    };
 
    enum type_schema
    {
        CELL = 3,
        MARRAY = 2,
        COLLECTION = 1
    };
 
    r_Database();
 
    explicit r_Database(const char *name);
    ~r_Database();
 
    void open(const char *database_name, access_status status = read_write);
    void close();
 
    void create(const char *name);
    void destroy(const char *name);
    void set_servername(const char *name, int port = DEFAULT_PORT);
    void set_useridentification(const char *name, const char *plain_pass);
    access_status get_status() const;
 
    void set_object_name(r_Object &obj, const char *name);
    r_Ref_Any lookup_object(const char *name) const;
    r_Ref_Any lookup_object(const r_OId &oid) const;
    r_Type *get_type_schema(const char *typeName, type_schema typetype);
    void set_transfer_format(r_Data_Format format, const char *formatParams = NULL);
    void set_storage_format(r_Data_Format format, const char *formatParams = NULL);
    static r_Database *actual_database;
 
    //@Man: Methods for internal use only:
    const r_OId get_new_oid(unsigned short objType) const;
 
 
    // creates an empty MDD collection on the server
    void insertColl(const char *collName, const char *typeName, const r_OId &oid);
 
    void removeObjFromColl(const char *name, const r_OId &oid);
 
    ClientComm *getComm();
 
private:
    ClientComm *communication{NULL};
 
    access_status db_status{not_open};
 
    std::string rasmgrName;
 
    int rasmgrPort;
 
    std::string userName;
 
    std::string plainPass;
};
 
#endif