corpus.h

Go to the documentation of this file.

// -*- C++ -*-
/*
  Phrasehunter - index and query text corpora
  Copyright (C) 2006  Torsten Marek (shlomme@gmx.de) &
  Armin Schmidt (armin.sch@gmail.com)
  
  This program 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 2
  of the License, or (at your option) any later version.
  
  This program 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 this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

#ifndef CORPUS_H
#define CORPUS_H CORPUS_H

#include <string>
#include <boost/filesystem/path.hpp>
#include <stdexcept>

#include "sqlitepp/sqlitepp.h"

#include "ph_types.h"
#include "phexception.h"

namespace PhraseHunter {

//! Class for managing corpus repositories.
class CorpusManager 
{
    
public:
    //! The mode in which a CorpusManager object should operate
    enum Mode {
        Read = 1,
        Write = 2,
    };

    /**
       \brief Constructor.
       \param corpus_repository Path to the base directory of the corpus.
       \param mode The mode in which a CorpusManager object should operate.
    */
    CorpusManager(const std::string& corpus_repository, CorpusManager::Mode mode = Read)
        throw(Exceptions::NoSuchCorpusError);
    
    ~CorpusManager();

    //! Factory function that returns a pointer to a newly constructed SearchEngine object.
    SearchEngine* searchEngine();
    //! Factory function that returns a pointer to a newly constructed StatisticsEngine object.
    StatisticsEngine* statisticsEngine();
    //! Factory function that returns a pointer to a newly constructed ContextReader object.
    ContextReader* contextReader();

    //! Get the file name for a particular DocID
    std::string documentName(DocID docID);

    /**
       \brief Add a file to the repository.
       \param filename The file to be added
       \param info String holding information about this file. Will be written to info file.
    */
    void addFile(const std::string& filename, const std::string& info)
        throw (Exceptions::FileError, Exceptions::NoIndexerError, std::out_of_range);
    //! Remove a particular file from the repository.
    void removeFile(DocID docID) throw(Exceptions::NoIndexerError);
    
private:
    inline boost::filesystem::path textDir() 
    {
        return m_directory / Repository::TextDirectory;
    }
    
    inline boost::filesystem::path indexFile() 
    {
        return m_directory / Repository::IndexFile;
    }
    CorpusManager::Mode m_mode;
    IndexManager* m_indexer;
    const boost::filesystem::path m_directory;
    SearchEngine* m_searchEngine;
    StatisticsEngine* m_statistics;
    ContextReader* m_contextReader;
    
    SQLitePP::SqliteDB m_db;
    struct Repository
    {
        static const int Format;
        static const std::string TextDirectory;
        static const std::string InfoFile;
        static const std::string IndexFile;
    };
};

}


#endif // CORPUS_H

---