source: trunk/gsdl/src/colservr/queryinfo.h@ 326

/**********************************************************************
 *
 * queryinfo.h -- 
 * Copyright (C) 1999  The New Zealand Digital Library Project
 *
 * PUT COPYRIGHT NOTICE HERE
 *
 * $Id: queryinfo.h 326 1999-07-01 03:56:17Z rjmcnab $
 *
 *********************************************************************/


#ifndef QUERYINFO_H
#define QUERYINFO_H


#include "gsdlconf.h"
#include "text_t.h"

#if defined(GSDL_USE_OBJECTSPACE)
#  include <ospace\std\vector>
#  include <ospace\std\algorithm>
#elif defined(GSDL_USE_STL_H)
#  include <vector.h>
#  if defined(GSDL_USE_ALGO_H)
#    include <algo.h>
#  else
#    include <algorithm.h>
#  endif
#else
#  include <vector>
#  include <algorithm>
#endif

// query parameters

class queryparamclass 
{
public:
  text_t collection;
  text_t search_index;
  text_t querystring;
  int search_type; // 0 = boolean, 1 = ranked
  int casefolding;
  int stemming;
  int maxdocs;

  queryparamclass &operator=(const queryparamclass &q);
};

bool operator==(const queryparamclass &x, const queryparamclass &y);
bool operator!=(const queryparamclass &x, const queryparamclass &y);

// stream output for debugging purposes
ostream &operator<< (ostream &outs, queryparamclass &q);



// term frequencies

class termfreqclass 
{
public:
  text_t termstr;
  text_t termstemstr;
  text_tset utf8equivterms; // kept as utf8 string for fast matching
  unsigned int termfreq;
  
  termfreqclass &operator=(const termfreqclass &t);
};

bool operator==(const termfreqclass &x, const termfreqclass &y);
bool operator!=(const termfreqclass &x, const termfreqclass &y);
bool operator<(const termfreqclass &x, const termfreqclass &y);
bool operator>(const termfreqclass &x, const termfreqclass &y);

// stream output for debugging purposes
ostream &operator<< (ostream &outs, termfreqclass &q);



// one query result

class docresultclass {
public:
  docresultclass(void) {
    docnum=-1; docweight=0.0; num_query_terms_matched=0;
    query_phrase_match=false;
  };
  ~docresultclass(void) {};
  
  int docnum;
  float docweight;
  unsigned int num_query_terms_matched;  // not available on all versions of mg
  bool query_phrase_match;               // not available on all versions of mg
};

// stream output for debugging purposes
ostream &operator<< (ostream &outs, docresultclass &a);



// query results

class queryresultsclass {
public:
  queryresultsclass () {clear();}

  bool docs_matched_set;
  int docs_matched; // not available on all versions of mg
  bool is_approx;   // not available on all versions of mg

  bool postprocessed; // whether this record has been post-processed
  
  vector<docresultclass> docs;
  vector<termfreqclass> orgterms; // terms before they are sorted and uniqued
  vector<termfreqclass> terms;
  text_tarray termvariants;
  
  void clear ();
  queryresultsclass &operator=(const queryresultsclass &q);
  
  int getnumdocs () {
    if (docs_matched_set) return docs_matched;
    else return docs.size();
  }
  int getnumterms () {return terms.size();}
  
  void sortuniqqueryterms();
};

// stream output for debugging purposes
ostream &operator<< (ostream &outs, queryresultsclass &q);


#endif