1 | /**********************************************************************
|
---|
2 | *
|
---|
3 | * lucenesearch.h -- implementation of search class for lucene
|
---|
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 | *
|
---|
25 | *
|
---|
26 | *********************************************************************/
|
---|
27 |
|
---|
28 |
|
---|
29 | #ifndef LUCENESEARCH_H
|
---|
30 | #define LUCENESEARCH_H
|
---|
31 |
|
---|
32 | #include "search.h"
|
---|
33 |
|
---|
34 | class lucenesearchclass : public searchclass {
|
---|
35 | public:
|
---|
36 | lucenesearchclass ();
|
---|
37 | virtual ~lucenesearchclass ();
|
---|
38 |
|
---|
39 | virtual text_t get_textindex_type() {return "lucene";}
|
---|
40 |
|
---|
41 | // the search results are returned in queryresults
|
---|
42 | // search returns 'true' if it was able to do a search
|
---|
43 | virtual bool search(const queryparamclass &queryparams,
|
---|
44 | queryresultsclass &queryresults);
|
---|
45 |
|
---|
46 | // this returns a list of terms in queryresults - no document info is returned
|
---|
47 | // returns a list of numTerms terms, starting from the query string term (in queryparams)
|
---|
48 | // + start. used for full text browsing
|
---|
49 | virtual bool browse_search(const queryparamclass &queryparams, int start, int numTerms,
|
---|
50 | queryresultsclass &queryresults);
|
---|
51 |
|
---|
52 | // the document text for 'docnum' is placed in 'output'
|
---|
53 | // docTargetDocument returns 'true' if it was able to
|
---|
54 | // try to get a document
|
---|
55 | // collection is needed to see if an index from the
|
---|
56 | // collection is loaded. If no index has been loaded
|
---|
57 | // defaultindex is needed to load one
|
---|
58 | virtual bool docTargetDocument(const text_t &defaultindex,
|
---|
59 | const text_t &defaultsubcollection,
|
---|
60 | const text_t &defaultlanguage,
|
---|
61 | const text_t &collection,
|
---|
62 | int docnum,
|
---|
63 | text_t &output);
|
---|
64 |
|
---|
65 | /* // same as docTargetDocument except the document is returned
|
---|
66 | // in its raw form. UDoc remains the property of mg and may
|
---|
67 | // be destroyed on the next call to mg.
|
---|
68 | // not implemented for lucene
|
---|
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);
|
---|
75 | */
|
---|
76 |
|
---|
77 | void set_text_level(const text_t &textlevel_arg);
|
---|
78 | text_t textlevel;
|
---|
79 |
|
---|
80 | // used to clear any cached databases for persistent versions of
|
---|
81 | // Greenstone like the Windows local library
|
---|
82 | void unload_database ();
|
---|
83 |
|
---|
84 | void set_gsdlhome (const text_t &gh);
|
---|
85 |
|
---|
86 | protected:
|
---|
87 | text_t getindexsuffix(const queryparamclass &qp);
|
---|
88 |
|
---|
89 | private:
|
---|
90 | text_t gsdlhome;
|
---|
91 |
|
---|
92 | };
|
---|
93 |
|
---|
94 |
|
---|
95 | #endif
|
---|
96 |
|
---|