Package | Description |
---|---|
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.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.cache |
Caching to speed up facets accumulation.
|
org.apache.lucene.facet.search.params |
Parameters for Faceted Search
|
org.apache.lucene.facet.util |
Various utilities for faceted search
|
Modifier and Type | Interface and Description |
---|---|
interface |
EnhancementsIndexingParams
Facet indexing parameters for defining
category enhancements . |
Modifier and Type | Class and Description |
---|---|
class |
DefaultEnhancementsIndexingParams
Default implementation of
EnhancementsIndexingParams |
Modifier and Type | Field and Description |
---|---|
protected FacetIndexingParams |
CategoryDocumentBuilder.indexingParams
Parameters to be used when indexing categories.
|
Constructor and Description |
---|
CategoryDocumentBuilder(TaxonomyWriter taxonomyWriter,
FacetIndexingParams params)
Creating a facets document builder with a given facet indexing parameters
object.
|
FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor(FacetIndexingParams indexingParams,
int[] ordinalMap)
Construct FacetsDirPayloadProcessor with custom FacetIndexingParams
|
FacetsPayloadProcessorProvider(Directory dir,
int[] ordinalMap,
FacetIndexingParams indexingParams)
Construct FacetsPayloadProcessorProvider with FacetIndexingParams
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultFacetIndexingParams
Default implementation for
FacetIndexingParams . |
class |
PerDimensionIndexingParams
A FacetIndexingParams that utilizes different category lists, defined by the
dimension specified CategoryPaths (see
PerDimensionIndexingParams.addCategoryListParams(CategoryPath, CategoryListParams)
A 'dimension' is defined as the first or "zero-th" component in a
CategoryPath. |
Modifier and Type | Field and Description |
---|---|
protected FacetIndexingParams |
CategoryTokenizerBase.indexingParams
Indexing params for creating term text
|
Constructor and Description |
---|
CategoryListTokenizer(TokenStream input,
FacetIndexingParams indexingParams) |
CategoryParentsStream(CategoryAttributesStream input,
TaxonomyWriter taxonomyWriter,
FacetIndexingParams indexingParams)
Constructor.
|
CategoryTokenizer(TokenStream input,
FacetIndexingParams indexingParams) |
CategoryTokenizerBase(TokenStream input,
FacetIndexingParams indexingParams)
Constructor.
|
CountingListTokenizer(TokenStream input,
FacetIndexingParams indexingParams) |
Modifier and Type | Method and Description |
---|---|
TotalFacetCounts |
TotalFacetCountsCache.getTotalCounts(IndexReader indexReader,
TaxonomyReader taxonomy,
FacetIndexingParams facetIndexingParams,
CategoryListCache clCache)
Get the total facet counts for a reader/taxonomy pair and facet indexing parameters.
|
void |
TotalFacetCountsCache.load(File inputFile,
IndexReader indexReader,
TaxonomyReader taxonomy,
FacetIndexingParams facetIndexingParams)
Load
TotalFacetCounts matching input parameters from the provided outputFile
and add them into the cache for the provided indexReader, taxonomy, and facetIndexingParams. |
static Query |
DrillDown.query(FacetIndexingParams iParams,
CategoryPath... paths)
Return a query for drilling down into all given categories (AND).
|
static Query |
DrillDown.query(FacetIndexingParams iParams,
Query baseQuery,
CategoryPath... paths)
Turn a base query into a drilling-down query for all given category paths (AND).
|
void |
TotalFacetCountsCache.store(File outputFile,
IndexReader indexReader,
TaxonomyReader taxonomy,
FacetIndexingParams facetIndexingParams,
CategoryListCache clCache)
Store the
TotalFacetCounts matching input parameters into the provided outputFile,
making them available for a later call to TotalFacetCountsCache.load(File, IndexReader, TaxonomyReader, FacetIndexingParams) . |
static Term |
DrillDown.term(FacetIndexingParams iParams,
CategoryPath path)
Return a term for drilling down into a category.
|
Modifier and Type | Method and Description |
---|---|
void |
CategoryListCache.loadAndRegister(CategoryListParams clp,
IndexReader reader,
TaxonomyReader taxo,
FacetIndexingParams iparams)
Load and register
CategoryListData . |
Modifier and Type | Field and Description |
---|---|
protected FacetIndexingParams |
FacetSearchParams.indexingParams |
Modifier and Type | Method and Description |
---|---|
FacetIndexingParams |
FacetSearchParams.getFacetIndexingParams()
A list of
FacetRequest objects, determining what to count. |
Constructor and Description |
---|
FacetSearchParams(FacetIndexingParams indexingParams)
Construct with specific faceted indexing parameters.
|
Modifier and Type | Method and Description |
---|---|
static String |
PartitionsUtils.partitionNameByOrdinal(FacetIndexingParams iParams,
CategoryListParams clParams,
int ordinal)
Partition name by category ordinal
|
static int |
PartitionsUtils.partitionNumber(FacetIndexingParams iParams,
int ordinal)
Partition number of an ordinal.
|
static int |
PartitionsUtils.partitionOffset(FacetIndexingParams iParams,
int partitionNumber,
TaxonomyReader taxonomyReader)
Get the offset for a given partition.
|
static int |
PartitionsUtils.partitionSize(FacetIndexingParams indexingParams,
TaxonomyReader taxonomyReader)
Get the partition size in this parameter, or return the size of the taxonomy, which
is smaller.
|