All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class |
Description |
AdaptiveFacetsAccumulator |
|
Aggregator |
An Aggregator is the analogue of Lucene's Collector (see
Collector ), for processing the categories
belonging to a certain document.
|
ArrayHashMap<K,V> |
An Array-based hashtable which maps, similar to Java's HashMap, only
performance tests showed it performs better.
|
AssociationEnhancement |
|
AssociationFloatProperty |
An AssociationProperty which treats the association as float - the
association bits are actually float bits, and thus merging two associations
is done by float summation.
|
AssociationFloatSumAggregator |
An Aggregator which updates the weight of a category by summing the
weights of the float association it finds for every document.
|
AssociationFloatSumFacetRequest |
Facet request for weighting facets according to their float association by
summing the association values.
|
AssociationIntProperty |
An AssociationProperty which treats the association as int - merges
two associations by summation.
|
AssociationIntSumAggregator |
An Aggregator which updates the weight of a category by summing the
weights of the integer association it finds for every document.
|
AssociationIntSumFacetRequest |
Facet request for weighting facets according to their integer association by
summing the association values.
|
AssociationListTokenizer |
Tokenizer for associations of a category
|
AssociationProperty |
|
AssociationsPayloadIterator |
Allows easy iteration over the associations payload, decoding and breaking it
to (ordinal, value) pairs, stored in a hash.
|
CategoryAttribute |
An attribute which contains for a certain category the CategoryPath
and additional properties.
|
CategoryAttributeImpl |
|
CategoryAttributesIterable |
|
CategoryAttributesStream |
|
CategoryContainer |
|
CategoryDocumentBuilder |
|
CategoryEnhancement |
This interface allows easy addition of enhanced category features.
|
CategoryListCache |
|
CategoryListData |
Category list data maintained in RAM.
|
CategoryListIterator |
An interface for iterating over a "category list", i.e., the list of
categories per document.
|
CategoryListParams |
Contains parameters for a category list *
|
CategoryListPayloadStream |
Accumulates category IDs for a single document, for writing in byte array
form, for example, to a Lucene Payload.
|
CategoryListTokenizer |
A base class for category list tokenizers, which add category list tokens to
category streams.
|
CategoryParentsStream |
|
CategoryPath |
A CategoryPath holds a sequence of string components, specifying the
hierarchical name of a category.
|
CategoryProperty |
|
CategoryTokenizer |
Basic class for setting the CharTermAttribute s and
PayloadAttribute s of category tokens.
|
CategoryTokenizerBase |
A base class for all token filters which add term and payload attributes to
tokens and are to be used in CategoryDocumentBuilder .
|
ChunksIntEncoder |
|
Cl2oTaxonomyWriterCache |
|
CollisionMap |
HashMap to store colliding labels.
|
CompactLabelToOrdinal |
This is a very efficient LabelToOrdinal implementation that uses a
CharBlockArray to store all labels and a configurable number of HashArrays to
reference the labels.
|
ComplementCountingAggregator |
|
CountFacetRequest |
Facet request for counting facets.
|
CountingAggregator |
A CountingAggregator updates a counter array with the size of the whole
taxonomy, counting the number of times each category appears in the given set
of documents.
|
CountingListTokenizer |
|
DefaultEnhancementsIndexingParams |
|
DefaultFacetIndexingParams |
|
DefaultOrdinalPolicy |
This class filters our the ROOT category ID.
|
DefaultPathPolicy |
This class filters our the ROOT category path.
|
DGapIntDecoder |
|
DGapIntEncoder |
An IntEncoderFilter which encodes the gap between the given values,
rather than the values themselves.
|
DirectoryTaxonomyReader |
A TaxonomyReader which retrieves stored taxonomy information from a
Directory .
|
DirectoryTaxonomyWriter |
TaxonomyWriter which uses a Directory to store the taxonomy
information on disk, and keeps an additional in-memory cache of some or all
categories.
|
DirectoryTaxonomyWriter.DiskOrdinalMap |
|
DirectoryTaxonomyWriter.MemoryOrdinalMap |
|
DirectoryTaxonomyWriter.OrdinalMap |
Mapping from old ordinal to new ordinals, used when merging indexes
wit separate taxonomies.
|
DoubleIterator |
Iterator interface for primitive double iteration.
|
DrillDown |
Creation of drill down term or query.
|
EightFlagsIntDecoder |
|
EightFlagsIntEncoder |
|
EnhancementsCategoryTokenizer |
|
EnhancementsDocumentBuilder |
|
EnhancementsIndexingParams |
|
EnhancementsPayloadIterator |
|
FacetArrays |
Provider of arrays used for facet operations such as counting.
|
FacetException |
A parent class for exceptions thrown by the Facets code.
|
FacetIndexingParams |
Parameters on how facets are to be written to the index.
|
FacetParamsMissingPropertyException |
Thrown when the facets params are missing a property.
|
FacetRequest |
Request to accumulate facet information for a specified facet and possibly
also some of its descendants, upto a specified depth.
|
FacetRequest.ResultMode |
|
FacetRequest.SortBy |
Sort options for facet results.
|
FacetRequest.SortOrder |
Requested sort order for the results.
|
FacetResult |
Result of faceted search.
|
FacetResultNode |
Result of faceted search for a certain taxonomy node.
|
FacetResultsHandler |
Handler for facet results.
|
FacetsAccumulator |
Driver for Accumulating facets of faceted search requests over given
documents.
|
FacetsCollector |
Collector for facet accumulation.
|
FacetSearchParams |
Faceted search parameters indicate for which facets should info be gathered.
|
FacetsPayloadProcessorProvider |
A PayloadProcessorProvider for updating facets ordinal references,
based on an ordinal map.
|
FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor |
|
FacetsPayloadProcessorProvider.FacetsPayloadProcessor |
A PayloadProcessor for updating facets ordinal references, based on an ordinal map
|
FloatArrayAllocator |
An FloatArrayAllocator is an object which manages float array objects
of a certain size.
|
FloatIterator |
Iterator interface for primitive int iteration.
|
FloatToObjectMap<T> |
An Array-based hashtable which maps primitive float to Objects of generic type
T.
The hashtable is constracted with a given capacity, or 16 as a default.
|
FourFlagsIntDecoder |
|
FourFlagsIntEncoder |
|
Heap<T> |
Declares an interface for heap (and heap alike) structures,
handling a given type T
|
InconsistentTaxonomyException |
Exception indicating that a certain operation could not be performed
on a taxonomy related object because of an inconsistency.
|
IntArray |
A Class wrapper for a grow-able int[] which can be sorted and intersect with
other IntArrays.
|
IntArrayAllocator |
An IntArrayAllocator is an object which manages counter array objects
of a certain length.
|
IntDecoder |
|
IntEncoder |
|
IntEncoderFilter |
An abstract implementation of IntEncoder which is served as a filter
on the values to encode.
|
IntermediateFacetResult |
|
IntHashSet |
A Set or primitive int.
|
IntIterator |
Iterator interface for primitive int iteration.
|
IntToDoubleMap |
An Array-based hashtable which maps primitive int to a primitive double.
The hashtable is constracted with a given capacity, or 16 as a default.
|
IntToIntMap |
An Array-based hashtable which maps primitive int to primitive int.
The hashtable is constracted with a given capacity, or 16 as a default.
|
IntToObjectMap<T> |
An Array-based hashtable which maps primitive int to Objects of generic type
T.
The hashtable is constracted with a given capacity, or 16 as a default.
|
LabelToOrdinal |
Abstract class for storing Label->Ordinal mappings in a taxonomy.
|
LRUHashMap<K,V> |
LRUHashMap is an extension of Java's HashMap, which has a bounded size();
When it reaches that size, each time a new element is added, the least
recently used (LRU) entry is removed.
|
LruTaxonomyWriterCache |
|
LruTaxonomyWriterCache.LRUType |
|
MultiCategoryListIterator |
|
MutableFacetResultNode |
Mutable implementation for Result of faceted search for a certain taxonomy node.
|
NameHashIntCacheLRU |
An an LRU cache of mapping from name to int.
|
NOnesIntDecoder |
|
NOnesIntEncoder |
A variation of FourFlagsIntEncoder which translates the data as
follows:
Values ≥ 2 are trnalsated to value+1 (2 ⇒ 3, 3
⇒ 4 and so forth).
|
NonTopLevelOrdinalPolicy |
Filter out any "top level" category ordinals.
|
NonTopLevelPathPolicy |
This class filters our the ROOT category, and it's direct descendants.
|
ObjectToFloatMap<K> |
An Array-based hashtable which maps Objects of generic type
T to primitive float values.
The hashtable is constructed with a given capacity, or 16 as a default.
|
ObjectToIntMap<K> |
An Array-based hashtable which maps Objects of generic type
T to primitive int values.
The hashtable is constructed with a given capacity, or 16 as a default.
|
OrdinalPolicy |
|
OrdinalProperty |
|
PartitionsUtils |
Utilities for partitions - sizes and such
|
PathPolicy |
Filtering category paths in CategoryParentsStream , where a given
category is added to the stream, and than all its parents are being
added one after the other by successively removing the last component.
|
PayloadIntDecodingIterator |
A payload deserializer comes with its own working space (buffer).
|
PayloadIterator |
A utility class for iterating through a posting list of a given term and
retrieving the payload of the first occurrence in every document.
|
PerDimensionIndexingParams |
|
RandomSampler |
Simple random sampler
|
RepeatableSampler |
Take random samples of large collections.
|
ResultSortUtils |
Utilities for generating facet results sorted as required
|
SampleFixer |
Fixer of sample facet accumulation results
|
Sampler |
Sampling definition for facets accumulation
|
Sampler.SampleResult |
Result of sample computation
|
SamplingAccumulator |
Facets accumulation with sampling.
|
SamplingParams |
Parameters for sampling, dictating whether sampling is to take place and how.
|
SamplingWrapper |
Wrap any Facets Accumulator with sampling.
|
ScoredDocIdCollector |
A Collector which stores all docIDs and their scores in a
ScoredDocIDs instance.
|
ScoredDocIDs |
Document IDs with scores for each, driving facets accumulation.
|
ScoredDocIDsIterator |
Iterator over document IDs and their scores.
|
ScoredDocIdsUtils |
Utility methods for Scored Doc IDs.
|
ScoreFacetRequest |
Facet request for weighting facets according to document scores.
|
ScoringAggregator |
An Aggregator which updates the weight of a category according to the
scores of the documents it was found in.
|
SimpleIntDecoder |
|
SimpleIntEncoder |
A simple IntEncoder , writing an integer as 4 raw bytes.
|
SortingIntEncoder |
An IntEncoderFilter which sorts the values to encode in ascending
order before encoding them.
|
StandardFacetsAccumulator |
Standard implementation for FacetsAccumulator , utilizing partitions to save on memory.
|
TaxonomyReader |
TaxonomyReader is the read-only interface with which the faceted-search
library uses the taxonomy during search time.
|
TaxonomyReader.ChildrenArrays |
Equivalent representations of the taxonomy's parent info,
used internally for efficient computation of facet results:
"youngest child" and "oldest sibling"
|
TaxonomyWriter |
TaxonomyWriter is the interface which the faceted-search library uses
to dynamically build the taxonomy at indexing time.
|
TaxonomyWriterCache |
TaxonomyWriterCache is a relatively simple interface for a cache of
category->ordinal mappings, used in TaxonomyWriter implementations
(such as DirectoryTaxonomyWriter ).
|
TemporaryObjectAllocator<T> |
An TemporaryObjectAllocator is an object which manages large, reusable,
temporary objects needed during multiple concurrent computations.
|
TopKFacetResultsHandler |
Generate Top-K results for a particular FacetRequest.
|
TopKInEachNodeHandler |
|
TopKInEachNodeHandler.IntermediateFacetResultWithHash |
Intermediate result to hold counts from one or more partitions processed
thus far.
|
TotalFacetCounts |
Maintain Total Facet Counts per partition, for given parameters:
Index reader of an index
Taxonomy index reader
Facet indexing params (and particularly the category list params)
The total facet counts are maintained as an array of arrays of integers,
where a separate array is kept for each partition.
|
TotalFacetCountsCache |
Manage an LRU cache for TotalFacetCounts per index, taxonomy, and
facet indexing params.
|
UniqueValuesIntEncoder |
|
UnsafeByteArrayInputStream |
|
UnsafeByteArrayOutputStream |
This class is used as a wrapper to a byte array, extending
OutputStream .
|
Vint8 |
Variable-length encoding of 32-bit integers, into 8-bit bytes.
|
Vint8.Position |
Because Java lacks call-by-reference, this class boxes the decoding position, which
is initially set by the caller, and returned after decoding, incremented by the number
of bytes processed.
|
VInt8IntDecoder |
|
VInt8IntEncoder |
An IntEncoder which implements variable length encoding.
|