OpenTREP Logo  0.07.4
C++ Open Travel Request Parsing Library
ResultCombination.hpp
Go to the documentation of this file.
1 #ifndef __OPENTREP_BOM_RESULTCOMBINATION_HPP
2 #define __OPENTREP_BOM_RESULTCOMBINATION_HPP
3 
4 // //////////////////////////////////////////////////////////////////////
5 // Import section
6 // //////////////////////////////////////////////////////////////////////
7 // OpenTrep
11 
12 // Forward declarations
13 namespace Xapian {
14  class Database;
15 }
16 
17 namespace OPENTREP {
18 
19  // Forward declarations
20  struct StringSet;
21 
25  class ResultCombination : public BomAbstract {
26  friend class FacResultCombination;
27  public:
28  // ////////////// Getters /////////////
32  const TravelQuery_T& getQueryString() const {
33  return _travelQuery;
34  }
35 
40  return _resultHolderList;
41  }
42 
46  bool hasFullTextMatched() const {
47  return (_bestMatchingResultHolder != NULL);
48  }
49 
56 
62  const Percentage_T& getBestMatchingWeight() const;
63 
71 
72 
73  public:
74  // /////////// Business methods ///////////
78  void displayXapianPercentages() const;
79 
83  void calculateEnvelopeWeights() const;
84 
89  void calculateCodeMatches() const;
90 
94  void calculatePageRanks() const;
95 
99  void calculateHeuristicWeights() const;
100 
104  void calculateCombinedWeights() const;
105 
109  void calculateAllWeights();
110 
117 
118 
119  public:
120  // /////////// Display support methods /////////
126  void toStream (std::ostream&) const;
127 
133  void fromStream (std::istream&);
134 
138  std::string toString() const;
139 
144  std::string describeKey() const;
145 
150  std::string describeShortKey() const;
151 
152 
153  private:
154  // ////////////// Constructors and Destructors /////////////
162  ~ResultCombination ();
166  void init ();
167 
168  private:
177 
178 
179  private:
180  // /////////////// Attributes ////////////////
184  const TravelQuery_T _travelQuery;
185 
189  ResultHolderList_T _resultHolderList;
190 
194  const ResultHolder* _bestMatchingResultHolder;
195  };
196 
197 }
198 #endif // __OPENTREP_BOM_RESULTCOMBINATION_HPP
OPENTREP::TravelQuery_T
std::string TravelQuery_T
Definition: OPENTREP_Types.hpp:660
OPENTREP::ResultCombination::calculateCombinedWeights
void calculateCombinedWeights() const
Definition: ResultCombination.cpp:181
OPENTREP::ResultCombination::displayXapianPercentages
void displayXapianPercentages() const
Definition: ResultCombination.cpp:111
OPENTREP::StringSet
Class holding a set of strings, e.g., {"rio", "de", "janeiro"}.
Definition: StringSet.hpp:19
OPENTREP::ResultCombination::chooseBestMatchingResultHolder
bool chooseBestMatchingResultHolder()
Definition: ResultCombination.cpp:229
OPENTREP::Percentage_T
double Percentage_T
Definition: OPENTREP_Types.hpp:670
OPENTREP::ResultCombination::calculatePageRanks
void calculatePageRanks() const
Definition: ResultCombination.cpp:153
ResultHolderList.hpp
OPENTREP::ResultCombination::calculateHeuristicWeights
void calculateHeuristicWeights() const
Definition: ResultCombination.cpp:167
OPENTREP::ResultCombination::describeShortKey
std::string describeShortKey() const
Definition: ResultCombination.cpp:73
OPENTREP
Definition: BasChronometer.cpp:10
OPENTREP::ResultCombination::getCorrectedStringSet
StringSet getCorrectedStringSet() const
Definition: ResultCombination.cpp:66
OPENTREP::ResultCombination
Class wrapping functions on a list of ResultHolder objects.
Definition: ResultCombination.hpp:25
OPENTREP::ResultCombination::getBestMatchingWeight
const Percentage_T & getBestMatchingWeight() const
Definition: ResultCombination.cpp:59
OPENTREP::ResultCombination::calculateCodeMatches
void calculateCodeMatches() const
Definition: ResultCombination.cpp:139
OPENTREP::ResultCombination::getQueryString
const TravelQuery_T & getQueryString() const
Definition: ResultCombination.hpp:32
OPENTREP::ResultCombination::fromStream
void fromStream(std::istream &)
Definition: ResultCombination.cpp:107
OPENTREP::BomAbstract
Base class for the Business Object Model (BOM) layer.
Definition: BomAbstract.hpp:17
OPENTREP::ResultCombination::getBestMatchingResultHolder
const ResultHolder & getBestMatchingResultHolder() const
Definition: ResultCombination.cpp:46
OPENTREP::ResultHolder
Class wrapping functions on a list of Result objects.
Definition: ResultHolder.hpp:26
OPENTREP::ResultCombination::calculateAllWeights
void calculateAllWeights()
Definition: ResultCombination.cpp:195
OPENTREP::ResultHolderList_T
std::list< ResultHolder * > ResultHolderList_T
Definition: ResultHolderList.hpp:13
BomAbstract.hpp
OPENTREP::ResultCombination::hasFullTextMatched
bool hasFullTextMatched() const
Definition: ResultCombination.hpp:46
OPENTREP::ResultCombination::describeKey
std::string describeKey() const
Definition: ResultCombination.cpp:80
OPENTREP::ResultCombination::toString
std::string toString() const
Definition: ResultCombination.cpp:85
OPENTREP::ResultCombination::calculateEnvelopeWeights
void calculateEnvelopeWeights() const
Definition: ResultCombination.cpp:125
OPENTREP::FacResultCombination
Definition: FacResultCombination.hpp:25
Xapian
Definition: ResultCombination.hpp:13
OPENTREP::ResultCombination::toStream
void toStream(std::ostream &) const
Definition: ResultCombination.cpp:102
OPENTREP_Types.hpp
OPENTREP::ResultCombination::getResultHolderList
const ResultHolderList_T & getResultHolderList() const
Definition: ResultCombination.hpp:39