← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to lucene/contrib/facet/src/java/org/apache/lucene/facet/search/package.html

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene/contrib/facet/src/java/org/apache/lucene/facet/search/package.html
1
 
<html>
2
 
  <head>
3
 
    <title>Faceted Search API</title>
4
 
  </head>
5
 
  <body>
6
 
    <h1>Faceted Search API</h1>
7
 
    
8
 
    API for faceted search has several interfaces - simple, top level ones, adequate for most users,
9
 
    and advanced, more complicated ones, for the more advanced users. 
10
 
    
11
 
    <p>
12
 
    
13
 
    We now describe the simpler interfaces.
14
 
    There are mainly 3 interfaces for faceted search:
15
 
    <ol>
16
 
      <li>{@link org.apache.lucene.facet.search.params.FacetRequest Facets Request}
17
 
          defines requirements:
18
 
          <ul> 
19
 
              <li>which facets are required, e.g. depth</li>
20
 
              <li>what is computed for each facet - e.g. count, score.</li>
21
 
          </ul>
22
 
      </li>
23
 
      <li>{@link org.apache.lucene.facet.search.FacetsAccumulator Facets Extractor}
24
 
          Controls how facets are extracted, with variations of:
25
 
          <ul> 
26
 
              <li>default (partitioned, like all extractors). </li>
27
 
              <li>sampled - inspects only a fraction of the documents.</li>
28
 
          </ul>
29
 
      </li>
30
 
      <li>{@link org.apache.lucene.facet.search.FacetResultsHandler Facet Results Handler }
31
 
          Controls how results are further processed and merged (also between partitions):
32
 
          <ul> 
33
 
              <li>Top K.</li>
34
 
              <li>Tree.</li>
35
 
              <li>Tree with top K at each level</li>
36
 
              <li>...</li>
37
 
          </ul>
38
 
      </li>
39
 
    </ol>
40
 
 
41
 
  </body>
42
 
</html>
 
 
b'\\ No newline at end of file'