Changeset 1067 for branches/corba/gsdl/src/colservr/mgsearch.cpp

Timestamp:

2000-04-05T03:02:39+12:00 (24 years ago)

Author:

cs025

Message:

Corba first commit

File:

• branches/corba/gsdl/src/colservr/mgsearch.cpp (modified) (6 diffs)

branches/corba/gsdl/src/colservr/mgsearch.cpp

@@ -28 +28 @@
 /*
    $Log$
+   Revision 1.22.2.1  2000/04/04 15:02:32  cs025
+   Corba first commit
+
    Revision 1.22  1999/09/24 02:41:21  rjmcnab
    change to use has_unicode_letdig in text_t
@@ -391 +394 @@
 }
 
-
+/**
+ * search directs the whole execution of the search; a number of other
+ * functions in this class are called as a result, and precondition
+ * checks are also made
+ */
 bool mgsearchclass::search(const queryparamclass &queryparams, 
                queryresultsclass &queryresults) {
   assert (cache != NULL);
 
+  // clear any previous results
   queryresults.clear();
 
@@ -406 +414 @@
   if (makeindexcurrent (queryparams.index, queryparams.subcollection,
             queryparams.language, queryparams.collection)) {
+    // initialise the form of results
     setsearchmode (queryparams);
+
+    // execute the query
     submitquery (queryparams);
+
+    // retrieve the results
     getresults (queryparams, queryresults);
+
     return true;
   }
@@ -453 +467 @@
 }
 
-
+/**
+ * submitquery constructs the query string (into UTF8 encoding)
+ * and submits it using mgq_ask to the mg search engine.  Most
+ * of the processing will be done inside Greenstone
+ */
 void mgsearchclass::submitquery (const queryparamclass &queryparams)
 {
-  // sort out the query string
+  // sort out the query string; copy it, remove all special characters
+  // and then convert it to a string in UTF8 format
   text_t ttquerystring = queryparams.querystring;
   filterquery (ttquerystring);
@@ -464 +483 @@
   mgq_ask(querystring);
 
+  // destroy the temporary character array
   delete querystring;
 }
 
-
+/**
+ * getrults is called to retrieve the required data on the docs
+ * which responded to the query submitted in submitquery above.
+ *
+ * It calls the local mgquery (mgq) interface to MG several times,
+ * to obtain the document numbers, term frequencies, term variants
+ * etc.  All processing of the query will be done by Greenstone
+ * thereafter
+ */
 void mgsearchclass::getresults (const queryparamclass &queryparams,
                 queryresultsclass &queryresults) {
-
+  // get the configuration for the maximum number of documents to
+  // retrieve
   int howmany = queryparams.maxdocs;
   if (howmany == -1) howmany = MAXNUMDOCS;
@@ -504 +533 @@
 }
 
+/**
+ * Tidies the given querystring, removing special characters
+ */
 void mgsearchclass::filterquery (text_t &ttquerystring) {
   text_t::iterator ithere = ttquerystring.begin ();