summaryrefslogtreecommitdiffstats
path: root/juniper/README
blob: f044cad83e83e5e1adc8d27b6f677d5d09156ab0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
This module implements a result processing solution to create 
dynamic teasers and proximity boosting of documents based on the
input query. 

The module offers the following main interface:

rpinterface.h

    This interface provides access for Juniper to full query structure information.
    The query provider needs to implement the IQuery interface to allow Juniper 
    to traverse the query and possibly obtain additional information about each term.
    (see query.h which is included by rpinterface.h)

    This is the preferred result processing interface to Juniper.

    src/rpclient/testclient.cpp

    is an example of use of this interface.


Directory structure:
-------------------------
build    - contains the fbuild official build specification for Juniper
doc      - contains manually written and generated (doxygen) documentation 
           for Juniper.
include  - default public include file location
lib      - default library location
src  - the main source directory
src/rpclient         - example and regression test client
src/test             - unit and submodule tests using the Fastlib test framework
src/util  - contains some debug utilities for debugging/converting between
            unicode/iso character sets.

See INSTALL.txt for build instructions.