| 1 | /**********************************************************************
|
|---|
| 2 | *
|
|---|
| 3 | * search.h -- abstract search class for mg systems
|
|---|
| 4 | * Copyright (C) 1999 The New Zealand Digital Library Project
|
|---|
| 5 | *
|
|---|
| 6 | * A component of the Greenstone digital library software
|
|---|
| 7 | * from the New Zealand Digital Library Project at the
|
|---|
| 8 | * University of Waikato, New Zealand.
|
|---|
| 9 | *
|
|---|
| 10 | * This program is free software; you can redistribute it and/or modify
|
|---|
| 11 | * it under the terms of the GNU General Public License as published by
|
|---|
| 12 | * the Free Software Foundation; either version 2 of the License, or
|
|---|
| 13 | * (at your option) any later version.
|
|---|
| 14 | *
|
|---|
| 15 | * This program is distributed in the hope that it will be useful,
|
|---|
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 18 | * GNU General Public License for more details.
|
|---|
| 19 | *
|
|---|
| 20 | * You should have received a copy of the GNU General Public License
|
|---|
| 21 | * along with this program; if not, write to the Free Software
|
|---|
| 22 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|---|
| 23 | *
|
|---|
| 24 | * $Id: search.h 1324 2000-08-02 00:58:29Z kjm18 $
|
|---|
| 25 | *
|
|---|
| 26 | *********************************************************************/
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 | #ifndef SEARCH_H
|
|---|
| 30 | #define SEARCH_H
|
|---|
| 31 |
|
|---|
| 32 | #include "text_t.h"
|
|---|
| 33 | #include "querycache.h"
|
|---|
| 34 |
|
|---|
| 35 | #define RESULTCACHESIZE 10
|
|---|
| 36 | #define MAXNUMDOCS 1000000
|
|---|
| 37 | #define MAXNUMTERMS 100
|
|---|
| 38 |
|
|---|
| 39 | class searchclass {
|
|---|
| 40 | public:
|
|---|
| 41 | searchclass ();
|
|---|
| 42 | virtual ~searchclass ();
|
|---|
| 43 |
|
|---|
| 44 | // the index directory must be set before any searching
|
|---|
| 45 | // is done
|
|---|
| 46 | void setcollectdir (const text_t &thecollectdir);
|
|---|
| 47 |
|
|---|
| 48 | // the search results are returned in queryresults
|
|---|
| 49 | // search returns 'true' if it was able to do a search
|
|---|
| 50 | virtual bool search(const queryparamclass &queryparams,
|
|---|
| 51 | queryresultsclass &queryresults)=0;
|
|---|
| 52 |
|
|---|
| 53 | // the document text for 'docnum' is placed in 'output'
|
|---|
| 54 | // docTargetDocument returns 'true' if it was able to
|
|---|
| 55 | // try to get a document
|
|---|
| 56 | // collection is needed to see if an index from the
|
|---|
| 57 | // collection is loaded. If no index has been loaded
|
|---|
| 58 | // defaultindex is needed to load one
|
|---|
| 59 | virtual bool docTargetDocument(const text_t &defaultindex,
|
|---|
| 60 | const text_t &defaultsubcollection,
|
|---|
| 61 | const text_t &defaultlanguage,
|
|---|
| 62 | const text_t &collection,
|
|---|
| 63 | int docnum,
|
|---|
| 64 | text_t &output)=0;
|
|---|
| 65 |
|
|---|
| 66 | // same as docTargetDocument except the document is returned
|
|---|
| 67 | // in its raw form. UDoc remains the property of mg and may
|
|---|
| 68 | // be destroyed on the next call to mg.
|
|---|
| 69 | virtual bool mgdocument (const text_t &defaultindex,
|
|---|
| 70 | const text_t &defaultsubcollection,
|
|---|
| 71 | const text_t &defaultlanguage,
|
|---|
| 72 | const text_t &collection,
|
|---|
| 73 | int docnum,
|
|---|
| 74 | char *&UDoc, int &ULen)=0;
|
|---|
| 75 |
|
|---|
| 76 | protected:
|
|---|
| 77 | querycache *cache;
|
|---|
| 78 | text_t collectdir; // the collection directory
|
|---|
| 79 |
|
|---|
| 80 | };
|
|---|
| 81 |
|
|---|
| 82 |
|
|---|
| 83 | #endif
|
|---|
