file.h

Go to the documentation of this file.

/*
 * SwatDB
 *
 * @authors: See Contributors.doc for code contributors
 *
 * Copyright (c) 2020 Swarthmore College Computer Science Department
 * Swarthmore PA, Professors Tia Newhall, Ameet Soni
 */
 
#ifndef _SWATDB_FILE_H_
#define  _SWATDB_FILE_H_
 
#include <string>
#include <vector>
#include "swatdb_types.h"
 
// too many circular includes
class Catalog;
class BufferManager;
 
/* The class heirarchy:
 *                                                                              
 *                                File                                          
 *                          /             \
 *                                                                              
 *             RelationFile               IndexFile                             
 *                                                                              
 *              /        \                /        \
 *       HeapFile    Sorted File     BTreeIndex  HashIndex                      
 *                   (not impl)      (not impl)                                 
 */
 
// TODO: not fully implemented
class File {
 
  friend class Catalog;
  friend class FileManager;
 
  public:
 
     File(Catalog *catalog, BufferManager *buf_mgr);
 
    virtual ~File(); 
 
    virtual void createHeader() = 0;
 
    virtual void flushHeader() = 0;
 
    FileId getFileId();
 
    virtual void printFile();
 
    // TODO add this method:  maybe protected with Catalog friend
    // void setMyFID(FileId *file_id);
 
 
    PageId getHeaderId();
 
  protected:
 
    FileId  file_id;
 
    Catalog *catalog;
 
    BufferManager *buf_mgr;
 
    PageId header_id;
 
    void _setFileId(FileId file_id);
 
    
};
 
#endif