All Classes and Interfaces (Lucene 10.5.1 sandbox API)
Description: class index

# All Classes and Interfaces

Class
Description
AggregatedQueryLeafProfilerResult
This class is the internal representation of a profiled Query, corresponding to a single node in the query tree.
BigIntegerPoint
An indexed 128-bit `BigInteger` field.
CandidateSetOrdinalIterator
`OrdinalIterator` that filters out ordinals from delegate if they are not in the candidate set.
CombinedFieldQuery
Deprecated.
Use `CombinedFieldQuery` instead.
CombinedFieldQuery.Builder
A builder for `CombinedFieldQuery`.
CommonFacetBuilder
Common `FacetBuilder` that works with any `FacetCutter` and `OrdToLabel` provided by user.
ComparableSupplier<T>
Generates `Comparable` for provided ordinal.
ComparableUtils
Collection of static methods to provide most common comparables for sandbox faceting.
ComparableUtils.ByAggregatedValueComparable
Used for `ComparableUtils.byAggregatedValue(org.apache.lucene.sandbox.facet.recorders.CountFacetRecorder, org.apache.lucene.sandbox.facet.recorders.LongAggregationsFacetRecorder, int)` result.
ComparableUtils.ByCountAndLongValueComparable
Used for `ComparableUtils.byCount(CountFacetRecorder, LongValueFacetCutter)` result.
ComparableUtils.ByCountComparable
Used for `ComparableUtils.byCount(org.apache.lucene.sandbox.facet.recorders.CountFacetRecorder)` result.
ComparableUtils.ByLongValueComparable
Used for `ComparableUtils.byLongValue(org.apache.lucene.sandbox.facet.cutters.LongValueFacetCutter)` result.
ComparableUtils.ByOrdinalComparable
Used for `ComparableUtils.byOrdinal()` result.
CountFacetRecorder
`FacetRecorder` to count facets.
CoveringQuery
A `Query` that allows to have a configurable number or required matches per document.
DocValuesMultiRangeQuery
A few query builders for doc values multi range queries.
DocValuesMultiRangeQuery.ByteRange
Representation of a single clause in a MultiRangeQuery
DocValuesMultiRangeQuery.LongRange
Representation of a single clause in a MultiRangeQuery
DocValuesMultiRangeQuery.SortedNumericStabbingBuilder
Builder for creating a multi-range query for stabbing by SortedNumerics or Numerics field values.
DocValuesMultiRangeQuery.SortedSetStabbingBuilder
Builder for creating a multi-range query for stabbing by SortedSet or Sorted field values.
DoublePointMultiRangeBuilder
Builder for multi range queries for DoublePoints
DoubleRangeFacetCutter
`FacetCutter` for ranges of double values.
DrillSidewaysFacetOrchestrator
Utility class to orchestrate `FacetBuilder`s to collect facets using `DrillSideways`.
FacetBuilder
End-to-end (request, collection and results) management of a single facet request.
FacetCutter
Creates `LeafFacetCutter` for each leaf.
FacetFieldCollector
`Collector` that brings together `FacetCutter` and `FacetRecorder` to compute facets during collection phase.
FacetFieldCollectorManager<V>
Collector manager for `FacetFieldCollector`.
FacetOrchestrator
Utility class to orchestrate `FacetBuilder`s to setup and exec collection for multiple facets.
FacetRecorder
Record data for each facet of each doc.
FloatPointMultiRangeBuilder
Builder for multi range queries for FloatPoints
FloatPointNearestNeighbor
KNN search on top of N dimensional indexed float points.
FuzzyLikeThisQuery
Fuzzifies ALL terms provided as strings and then picks the best n differentiating terms.
HalfFloatPoint
An indexed `half-float` field for fast range filters.
HistogramCollectorManager
`CollectorManager` that computes a histogram of the distribution of the values of a field.
IDVersionPostingsFormat
A PostingsFormat optimized for primary-key (ID) fields that also record a version (long) for each ID, delivered as a payload created by `IDVersionPostingsFormat.longToBytes(long, org.apache.lucene.util.BytesRef)` during indexing.
IDVersionSegmentTermsEnum
Iterates through terms in this field; this class is public so users can cast it to call `IDVersionSegmentTermsEnum.seekExact(BytesRef, long)` for optimistic-concurrency, and also `IDVersionSegmentTermsEnum.getVersion()` to get the version of the currently seek'd term.
IntPointMultiRangeBuilder
Builder for multi range queries for IntPoints
KMeans
KMeans clustering algorithm for vectors
KMeans.KmeansInitializationMethod
Kmeans initialization methods
KMeans.Results
Results of KMeans clustering
LabelToOrd
Label to ord mapping interface.
LargeNumHitsTopDocsCollector
Optimized collector for large number of hits.
LargeNumHitsTopDocsCollectorManager
CollectorManager for `LargeNumHitsTopDocsCollector` that enables concurrent collection of top docs across multiple segments.
LatLonBoundingBox
An indexed 2-Dimension Bounding Box field for the Geospatial Lat/Lon Coordinate system
LeafFacetCutter
Interface to be implemented to cut documents into facets for an index segment (leaf).
LeafFacetRecorder
Record data for each facet of each doc of a leaf (segment).
LengthOrdinalIterator
`OrdinalIterator` passes through all ordinals as is and counts them.
LongAggregationsFacetRecorder
`FacetRecorder` that computes multiple long aggregations per facet.
LongPointMultiRangeBuilder
Builder for multi range queries for LongPoints
LongRangeFacetCutter
`FacetCutter` for ranges of long values.
LongValueFacetBuilder
`FacetBuilder` for distinct numeric field values.
LongValueFacetCutter
`FacetCutter` and `OrdToLabel` for distinct long values.
MergeOnFlushMergePolicy
A simple extension to wrap `MergePolicy` to merge all tiny segments (or at least segments smaller than specified in `MergeOnFlushMergePolicy.setSmallSegmentThresholdMB(double)` into one segment on commit.
MultiFacetsRecorder
`FacetRecorder` that contains multiple FacetRecorders.
MultiRangeQuery
Abstract class for range queries involving multiple ranges against physical points such as `IntPoints` All ranges are logically ORed together
MultiRangeQuery.Builder
A builder for multirange queries.
MultiRangeQuery.RangeClause
Representation of a single clause in a MultiRangeQuery
OrdinalIterator
Iterate over ordinals.
OrdToLabel
Ordinal to label mapping interface.
PayloadSpanCollector
SpanCollector for collecting payloads
PayloadSpanUtil
Experimental class to get set of payloads for most standard Lucene queries.
PhraseWildcardQuery
A generalized version of `PhraseQuery`, built with one or more `MultiTermQuery` that provides term expansions for multi-terms (one of the expanded terms must match).
PhraseWildcardQuery.Builder
Builds a `PhraseWildcardQuery`.
PhraseWildcardQuery.MultiTerm
Phrase term with expansions.
PhraseWildcardQuery.PhraseTerm
All `PhraseWildcardQuery.PhraseTerm` are light and immutable.
PhraseWildcardQuery.SingleTerm
Phrase term with no expansion.
PhraseWildcardQuery.TermBytesTermState
Holds a pair of term bytes - term state.
PhraseWildcardQuery.TermData
Holds the `TermState` for all the collected `Term`, for a specific phrase term, for all segments.
PhraseWildcardQuery.TermsData
Holds the `TermState` and `TermStatistics` for all the matched and collected `Term`, for all phrase terms, for all segments.
PhraseWildcardQuery.TermStats
Accumulates the doc freq and total term freq.
PhraseWildcardQuery.TestCounters
Test counters incremented when assertions are enabled.
PostCollectionFaceting<C,T,K,R>
Performs post-collection faceting by replaying collected documents through drill-down and drill-sideways collectors.
PostCollectionFaceting.Result<T,R>
The result.
ProfilerCollector
This class wraps a Collector and times the execution of: - setScorer() - collect() - doSetNextReader() - needsScores()
ProfilerCollectorManager
Collector manager for `ProfilerCollector`
ProfilerCollectorResult
Public class for profiled timings of the Collectors used in the search.
QueryLeafProfilerBreakdown
A record of timings for the various operations that may happen during query execution.
QueryProfilerIndexSearcher
An extension of `IndexSearcher` that records profile information for all queries it executes.
QueryProfilerResult
This class is the internal representation of a profiled Query, corresponding to a single node in the query tree.
QueryProfilerTimingType
This enum breaks down the query into different sections to describe what was timed.
RangeFacetBuilderFactory
`FacetBuilder` factory for faceting types base on numeric fields.
RangeOrdToLabel
`OrdToLabel` for ranges.
Reducer
Reducer for numeric values.
SampleReader
A reader of vector values that samples a subset of the vectors.
SortedNumericDocValuesMultiRangeQuery
A union multiple ranges over SortedNumericDocValuesField
SortedSetDocValuesMultiRangeQuery
A union multiple ranges over SortedSetDocValuesField
SortedSetDocValuesMultiRangeQuery.OrdRange
A range for ordinal ends.
TaxonomyChildrenOrdinalIterator
Facets results selector to get children for selected parent.
TaxonomyFacetBuilder
`FacetBuilder` for taxonomy facets.
TaxonomyFacetsCutter
`FacetCutter` for facets that use taxonomy side-car index.
TaxonomyOrdLabelBiMap
Map taxonomy labels to ordinals.
TermAutomatonQuery
A proximity query that lets you express an automaton, whose transitions are terms, to match documents.
TokenStreamToTermAutomatonQuery
Consumes a TokenStream and creates an `TermAutomatonQuery` where the transition labels are tokens from the `TermToBytesRefAttribute`.
TopnOrdinalIterator<T>
Class that consumes incoming ordinals, sorts them by provided Comparable, and returns first top N ordinals only.
VersionBlockTreeTermsReader
See `VersionBlockTreeTermsWriter`.
VersionBlockTreeTermsWriter
This is just like `Lucene103BlockTreeTermsWriter`, except it also stores a version per term, and adds a method to its TermsEnum implementation to seekExact only if the version is >= the specified version.