Result.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_RESULT_HPP
#define __OPENTREP_BOM_RESULT_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <list>
#include <map>
// Xapian
#include <xapian.h>
// OpenTREP
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/bom/BomAbstract.hpp>
#include <opentrep/bom/ScoreBoard.hpp>

namespace OPENTREP {

  // Forward declarations
  class ResultHolder;
  struct LocationKey;
  struct Location;
  class Place;


  // //////////////////// Type definitions /////////////////////
  typedef std::pair<Xapian::Document, ScoreBoard> XapianDocumentPair_T;

  typedef std::list<XapianDocumentPair_T> DocumentList_T;
  
  typedef std::map<Xapian::docid, XapianDocumentPair_T> DocumentMap_T;
  

  // //////////////////////// Main Class /////////////////////////
  class Result : public BomAbstract {
    friend class FacResultHolder;
    friend class FacResult;
  public:
    // ////////////////////// Getters /////////////////////
    const TravelQuery_T& getQueryString() const {
      return _queryString;
    }

    const TravelQuery_T& getCorrectedTravelQuery() const {
     return _correctedQueryString;
    }

    bool hasFullTextMatched() const {
      return _hasFullTextMatched;
    }

    const NbOfErrors_T& getEditDistance() const {
      return _editDistance;
    }
    
    const NbOfErrors_T& getAllowableEditDistance() const {
      return _allowableEditDistance;
    }
    
    const DocumentList_T& getDocumentList() const {
     return _documentList;
    }

    const DocumentMap_T& getDocumentMap() const {
     return _documentMap;
    }

    const XapianDocumentPair_T& getDocumentPair (const Xapian::docid&) const;

    const Xapian::Document& getDocument (const Xapian::docid&) const;

    const Xapian::docid& getBestDocID() const {
      return _bestDocID;
    }

    const Percentage_T& getBestCombinedWeight() const {
      return _bestCombinedWeight;
    }

    const RawDataString_T& getBestDocData() const {
      return _bestDocData;
    }

    const Xapian::Document& getBestXapianDocument() const {
      return getDocument (_bestDocID);
    }


  public:
    // ////////////////////// Setters /////////////////////
    void setQueryString (const TravelQuery_T& iQueryString) {
      _queryString = iQueryString;
    }

    void setCorrectedQueryString (const TravelQuery_T& iCorrectedQueryString) {
      _correctedQueryString = iCorrectedQueryString;
    }
    
    void setHasFullTextMatched (const bool iHasFullTextMatched) {
      _hasFullTextMatched = iHasFullTextMatched;
    }

    void setEditDistance (const NbOfErrors_T& iEditDistance) {
      _editDistance = iEditDistance;
    }
    
    void setAllowableEditDistance (const NbOfErrors_T& iAllowableEditDistance) {
      _allowableEditDistance = iAllowableEditDistance;
    }
    
    void addDocument (const Xapian::Document&, const Score_T&);

    void setBestDocID (const Xapian::docid& iDocID) {
      _bestDocID = iDocID;
    }

    void setBestCombinedWeight (const Percentage_T& iPercentage) {
      _bestCombinedWeight = iPercentage;
    }
    
    void setBestDocData (const std::string& iDocData) {
      _bestDocData = RawDataString_T (iDocData);
    }

    void fillResult (const Xapian::MSet& iMatchingSet);

    void fillPlace (Place&) const;


  public:
    // /////////////////// Business support methods /////////////////
    std::string fullTextMatch (const Xapian::Database&, const TravelQuery_T&);

    static Location retrieveLocation (const Xapian::Document&);

    static Location retrieveLocation (const RawDataString_T&);

    static LocationKey getPrimaryKey (const Xapian::Document&);

    static Score_T getEnvelopeID (const Xapian::Document&);

    static PageRank_T getPageRank (const Xapian::Document&);

    void displayXapianPercentages() const;

    void setScoreOnDocMap (const Xapian::docid&,
                           const ScoreType&, const Score_T&);

    void calculateEnvelopeWeights();

    void calculateCodeMatches();

    void calculatePageRanks();

    void calculateHeuristicWeights();

    void calculateCombinedWeights();

  private:
    std::string fullTextMatch (const Xapian::Database&, const TravelQuery_T&,
                               Xapian::MSet&);


  public:
    // /////////////////// Display support methods /////////////////
    void toStream (std::ostream& ioOut) const;

    void fromStream (std::istream& ioIn);

    std::string toString() const;
    
    std::string describeKey() const;

    std::string describeShortKey() const;


  private:
    // ////////////// Constructors and Destructors /////////////
    Result (const TravelQuery_T&, const Xapian::Database&);

    Result();

    Result (const Result&);

    ~Result();

    void init();

    
  private:
    // /////////////// Attributes ////////////////
    ResultHolder* _resultHolder;

    const Xapian::Database& _database;

    TravelQuery_T _queryString;

    TravelQuery_T _correctedQueryString;

    bool _hasFullTextMatched;

    NbOfErrors_T _editDistance;
    
    NbOfErrors_T _allowableEditDistance;
    
    Xapian::docid _bestDocID;

    Percentage_T _bestCombinedWeight;

    RawDataString_T _bestDocData;

    DocumentList_T _documentList;
  
    DocumentMap_T _documentMap;
  };

}
#endif // __OPENTREP_BOM_RESULT_HPP