SequenceFile.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 SEQUENCEFILE_H
#define SEQUENCEFILE_H

#include "PDBFile.h"
#include "DataTypes.h"
#include <string>
#include <memory>
#include "PDBLogger.h"

using namespace std;
class SequenceFile;
typedef shared_ptr<SequenceFile> SequenceFilePtr;

class SequenceFile : public PDBFileInterface {
public:
    SequenceFile(NodeID nodeId,
                 DatabaseID dbId,
                 UserTypeID typeId,
                 SetID setId,
                 string path,
                 pdb::PDBLoggerPtr logger,
                 size_t pageSize);
    ~SequenceFile();

    bool openAll() override;
    bool closeAll() override;
    void clear() override;
    int appendPage(FilePartitionID partitionId, PDBPagePtr page) override;
    int appendPage(PDBPagePtr page);
    int writeMeta() override;
    int updateMeta() override;

    size_t loadPage(PageID pageId, char* pageInCache, size_t length);

    size_t loadPage(FilePartitionID partitionId,
                    unsigned int pageSeqInPartition,
                    char* pageInCache,
                    size_t length) override;

    unsigned int getAndSetNumFlushedPages() override;
    unsigned int getNumFlushedPages() override;
    PageID getLastFlushedPageID() override;
    PageID getLatestPageID() override;
    size_t getPageSize() override;
    size_t getPageSizeInMeta() override;

    FileType getFileType() override {
        return FileType::SequenceFileType;
    }

    DatabaseID getDbId() override {
        return dbId;
    }

    NodeID getNodeId() override {
        return nodeId;
    }

    SetID getSetId() override {
        return setId;
    }

    UserTypeID getTypeId() override {
        return typeId;
    }

    string getPath() {
        return filePath;
    }


protected:
    int seekPageSizeInMeta();

    int seekLastFlushedPageID();

    int seekPage(PageID pageId);

    int writeData(void* data, size_t length);

    int seekEnd();

private:
    NodeID nodeId;
    DatabaseID dbId;
    UserTypeID typeId;
    SetID setId;
    FILE* file;
    string filePath;
    PageID lastFlushedId;
    unsigned int numFlushedPages;
    size_t pageSize = 0;
    size_t metaSize;
    pdb::PDBLoggerPtr logger;
};

#endif /* SEQUENCEFILE_H */