README
1Search-QueryParser version 1.0
2==============================
3
4This module parses a query string into a data structure to be handled
5by external search engines. For examples of such engines, see
6File::Tabular and Search::Indexer.
7
8The query string can contain simple terms, "exact phrases", field
9names and comparison operators, '+/-' prefixes, parentheses, and
10boolean connectors.
11
12The parser can be parameterized by regular expressions for specific
13notions of "term", "field name" or "operator" ; see the "new"
14method. The parser has no support for lemmatization or other term
15transformations : these should be done externally, before passing the
16query data structure to the search engine.
17
18The data structure resulting from a parsed query is a tree of terms
19and operators, as described in the "parse" method. The interpretation
20of the structure is up to the external search engine that will receive
21the parsed query ; the present module does not make any assumption
22about what it means to be "equal" or to "contain" a term.
23
24INSTALLATION
25
26To install this module type the following:
27
28 perl Makefile.PL
29 make
30 make test
31 make install
32
33DEPENDENCIES
34
35None
36
37RELATED MODULES
38
39File::Tabular (management of flat text files containg data organised
40in rows and columns) and Search::Indexer (full-text indexing)
41make use of the present module.
42
43COPYRIGHT AND LICENCE
44
45Copyright (C) 2005 by Laurent Dami.
46
47This library is free software; you can redistribute it and/or modify
48it under the same terms as Perl itself.
49
50
51