ResultCombination.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_RESULTCOMBINATION_HPP
#define __OPENTREP_BOM_RESULTCOMBINATION_HPP

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

// Forward declarations
namespace Xapian {
  class Database;
}

namespace OPENTREP {

  // Forward declarations
  struct StringSet;

  class ResultCombination : public BomAbstract {
    friend class FacResultCombination;
  public:
    // ////////////// Getters /////////////
    const TravelQuery_T& getQueryString() const {
      return _travelQuery;
    }

    const ResultHolderList_T& getResultHolderList() const {
      return _resultHolderList;
    }

    bool hasFullTextMatched() const {
      return (_bestMatchingResultHolder != NULL);
    }

    const ResultHolder& getBestMatchingResultHolder() const;

    const Percentage_T& getBestMatchingWeight() const;

    StringSet getCorrectedStringSet() const;


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

    void calculateEnvelopeWeights() const;

    void calculateCodeMatches() const;

    void calculatePageRanks() const;

    void calculateHeuristicWeights() const;

    void calculateCombinedWeights() const;

    bool chooseBestMatchingResultHolder();


  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 /////////////
    ResultCombination (const TravelQuery_T&);
    ~ResultCombination ();
    void init ();

  private:
    ResultCombination();
    ResultCombination (const ResultCombination&);
    
    
  private:
    // /////////////// Attributes ////////////////
    const TravelQuery_T _travelQuery;

    ResultHolderList_T _resultHolderList;

    const ResultHolder* _bestMatchingResultHolder;
  };

}
#endif // __OPENTREP_BOM_RESULTCOMBINATION_HPP