3 <title>Faceted Search API</title>
6 <h1>Faceted Search API</h1>
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.
13 We now describe the simpler interfaces.
14 There are mainly 3 interfaces for faceted search:
16 <li>{@link org.apache.lucene.facet.search.params.FacetRequest Facets Request}
19 <li>which facets are required, e.g. depth</li>
20 <li>what is computed for each facet - e.g. count, score.</li>
23 <li>{@link org.apache.lucene.facet.search.FacetsAccumulator Facets Extractor}
24 Controls how facets are extracted, with variations of:
26 <li>default (partitioned, like all extractors). </li>
27 <li>sampled - inspects only a fraction of the documents.</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):
35 <li>Tree with top K at each level</li>