PDBFile.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 PDBFILE_H
#define PDBFILE_H

#include <stdio.h>
#include <vector>
#include "DataTypes.h"
#include "PDBPage.h"
#include <memory>
using namespace std;

class PDBFileInterface;
typedef shared_ptr<PDBFileInterface> PDBFilePtr;

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

    virtual bool openAll() = 0;

    virtual bool closeAll() = 0;

    virtual void clear() = 0;

    virtual int appendPage(FilePartitionID partitionId, PDBPagePtr page) = 0;

    virtual int writeMeta() = 0;

    virtual int updateMeta() = 0;

    virtual size_t loadPage(FilePartitionID partitionId,
                            unsigned int pageSeqInPartition,
                            char* pageInCache,
                            size_t length) = 0;


    virtual unsigned int getAndSetNumFlushedPages() = 0;

    virtual unsigned int getNumFlushedPages() = 0;

    virtual NodeID getNodeId() = 0;

    virtual DatabaseID getDbId() = 0;

    virtual UserTypeID getTypeId() = 0;

    virtual SetID getSetId() = 0;

    virtual PageID getLastFlushedPageID() = 0;

    virtual PageID getLatestPageID() = 0;

    virtual size_t getPageSize() = 0;

    virtual size_t getPageSizeInMeta() = 0;

    virtual FileType getFileType() = 0;
};


#endif /* PDBFILE_H */