ResultHolder.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_RESULTHOLDER_HPP
#define __OPENTREP_BOM_RESULTHOLDER_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// OpenTrep
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/bom/BomAbstract.hpp>
#include <opentrep/bom/ResultList.hpp>

// Forward declarations
namespace Xapian {
  class Database;
}

namespace OPENTREP {

  // Forward declarations
  class ResultCombination;
  struct StringSet;

  class ResultHolder : public BomAbstract {
    friend class FacResultCombination;
    friend class FacResultHolder;
  public:
    // ////////////////////// Getters /////////////////////
    const TravelQuery_T& getQueryString() const {
      return _queryString;
    }

    const ResultList_T& getResultList() const {
      return _resultList;
    }

    const Percentage_T& getCombinedWeight() const {
      return _combinedWeight;
    }

    StringSet getCorrectedStringSet() const;


  public:
    // ////////////////////// Setters /////////////////////
    void setCombinedWeight (const Percentage_T& iPercentage) {
      _combinedWeight = iPercentage;
    }


  public:
    // /////////// Business methods ///////////
    void displayXapianPercentages() const;

    void calculateEnvelopeWeights() const;

    void calculateCodeMatches() const;

    void calculatePageRanks() const;

    void calculateHeuristicWeights() const;

    void calculateCombinedWeights();


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

    void fromStream (std::istream&);

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

    std::string describeShortKey() const;


  private:
    // ////////////// Constructors and Destructors /////////////
    ResultHolder (const TravelQuery_T&, const Xapian::Database&);
    ResultHolder();
    ResultHolder (const ResultHolder&);
    ~ResultHolder();
    void init();

    
  private:
    // /////////////// Attributes ////////////////
    ResultCombination* _resultCombination;

    const TravelQuery_T _queryString;

    const Xapian::Database& _database;
    
    ResultList_T _resultList;

    Percentage_T _combinedWeight;
  };

}
#endif // __OPENTREP_BOM_RESULTHOLDER_HPP