Database.h

Go to the documentation of this file.

/*****************************************************************************
 *                                                                           *
 *  Copyright 2018 Rice University                                           *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *      http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 *****************************************************************************/

#ifndef DATABASE_H
#define DATABASE_H

#include "PDBObject.h"
#include "UserType.h"
#include "PDBPage.h"
#include "DataTypes.h"

#include <vector>
using namespace std;

class DatabaseInterface {
public:
    /*
     * To support polymorphism.
     */
    virtual ~DatabaseInterface() {}

    virtual void addType(TypePtr type) = 0;

    virtual bool removeType(UserTypeID typeID) = 0;

    virtual void dump() = 0;

    virtual DatabaseID getDatabaseID() = 0;

    virtual string getDatabaseName() = 0;

    virtual bool addObject(PDBObjectPtr object, PageID& pageId, MiniPageID& miniPageId) = 0;

    virtual PDBObjectPtr getObject(UserTypeID typeID,
                                   SetID setID,
                                   PageID pageID,
                                   MiniPageID miniPageID) = 0;

    virtual PDBObjectPtr getObjectByOffset(UserTypeID typeID,
                                           SetID setID,
                                           PageID pageID,
                                           size_t offset) = 0;

    virtual PDBPagePtr getPage(UserTypeID typeID, SetID setID, PageID pageID) = 0;

    virtual int getNumPages(UserTypeID typeId, SetID setId) = 0;

    virtual TypePtr getType(UserTypeID typeId) = 0;

    virtual void flush() = 0;
};


#endif /* DATABASE_H */