Lucene 3.6.2 contrib-facet API

Provides faceted indexing and search capabilities (checkout the userguide).

See: Description

Packages 
Package Description
org.apache.lucene.facet
Provides faceted indexing and search capabilities.
org.apache.lucene.facet.enhancements
Enhanced category features Mechanisms for addition of enhanced category features.
org.apache.lucene.facet.enhancements.association
Association category enhancements A CategoryEnhancement for adding associations data to the index (categories with AssociationProperty's).
org.apache.lucene.facet.enhancements.params
Enhanced category features FacetIndexingParams used by EnhancementsDocumentBuilder for adding CategoryEnhancement's to the indexing parameters, and accessing them during indexing and search.
org.apache.lucene.facet.index
Indexing of document categories Attachment of CategoryPath's or CategoryAttribute's to a given document using a Taxonomy.
org.apache.lucene.facet.index.attributes
Category attributes and their properties for indexing Attributes for a category, possibly containing category property's.
org.apache.lucene.facet.index.categorypolicy
Policies for indexing categories There are two kinds of policies: Path policies are based on the path of the category.
org.apache.lucene.facet.index.params
Indexing-time specifications for handling facets Parameters on how facets are to be written to the index, such as which fields and terms are used to refer to the facets posting list.
org.apache.lucene.facet.index.streaming
Expert: attributes streaming definition for indexing facets Steaming of facets attributes is a low level indexing interface with Lucene indexing.
org.apache.lucene.facet.search
Faceted Search API API for faceted search has several interfaces - simple, top level ones, adequate for most users, and advanced, more complicated ones, for the more advanced users.
org.apache.lucene.facet.search.aggregator
Aggregating Facets during Faceted Search A facets aggregator is the parallel of Lucene's Collector.
org.apache.lucene.facet.search.aggregator.association
Association-based aggregators.
org.apache.lucene.facet.search.cache
Caching to speed up facets accumulation.
org.apache.lucene.facet.search.params
Parameters for Faceted Search
org.apache.lucene.facet.search.params.association
Association-based Parameters for Faceted Search.
org.apache.lucene.facet.search.results
Results of Faceted Search
org.apache.lucene.facet.search.sampling
Sampling for facets accumulation
org.apache.lucene.facet.taxonomy
Taxonomy of Categories Facets are defined using a hierarchy of categories, known as a Taxonomy
For example, in a book store application, a Taxonomy could have the following hierarchy: Author Mark Twain J.
org.apache.lucene.facet.taxonomy.directory
Taxonomy implemented using a Lucene-Index
org.apache.lucene.facet.taxonomy.writercache
Improves indexing time by caching a map of CategoryPath to their Ordinal
org.apache.lucene.facet.taxonomy.writercache.cl2o
Category->Ordinal caching implementation using an optimized data-structures The internal map data structure consumes less memory (~30%) and is faster (~50%) compared to a Java HashMap<String, Integer>.
org.apache.lucene.facet.taxonomy.writercache.lru
An LRU cache implementation for the CategoryPath to Ordinal map
org.apache.lucene.facet.util
Various utilities for faceted search
org.apache.lucene.util  
org.apache.lucene.util.collections
Various optimized Collections implementations.
org.apache.lucene.util.encoding
Offers various encoders and decoders for integers, as well as the mechanisms to create new ones.