jruby/docs BETA

Apache Lucene (JRuby)

1136 classes 169 packages 156 public · 13 internal

org.apache.lucene.analysis 24

C AbstractAnalysisFactory — Abstract parent class for analysis factories TokenizerFactory, TokenFilterFactory and CharFilterFactory. C AnalysisSPILoader — Helper class for loading named SPIs from classpath (e.g. C Analyzer — An Analyzer builds TokenStreams, which analyze text. C AnalyzerWrapper — Extension to Analyzer suitable for Analyzers which wrap other Analyzers. C AutomatonToTokenStream — Converts an Automaton into a TokenStream. C CachingTokenFilter — This class can be used if the token attributes of a TokenStream are intended to be consumed more than once. C CharArrayMap — A simple class that stores key Strings as char[]'s in a hash table. C CharArraySet — A simple class that stores Strings as char[]'s in a hash table. C CharFilter — Subclasses of CharFilter can be chained to filter a Reader They can be used as java.io.Reader with additional offset correction. C CharFilterFactory — Abstract parent class for analysis factories that create CharFilter instances. C CharacterUtils — Utility class to write tokenizers or token filters. C DelegatingAnalyzerWrapper — An analyzer wrapper, that doesn't allow to wrap components or readers. C FilteringTokenFilter — Abstract base class for TokenFilters that may remove tokens. C GraphTokenFilter — An abstract TokenFilter that exposes its input stream as a graph Call #incrementBaseToken() to move the root of the graph to the next position in the TokenStream, #incrementGraphToken() to move along the current graph, and #incrementGraph() to reset to the next graph based at the current root. C LowerCaseFilter — Normalizes token text to lower case. C StopFilter — Removes stop words from a token stream. C StopwordAnalyzerBase — Base class for Analyzers that need to make use of stopword sets. C TokenFilter — A TokenFilter is a TokenStream whose input is another TokenStream. C TokenFilterFactory — Abstract parent class for analysis factories that create org.apache.lucene.analysis.TokenFilter instances. C TokenStream — A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text. C TokenStreamToAutomaton — Consumes a TokenStream and creates an Automaton where the transition labels are UTF8 bytes (or Unicode code points if unicodeArcs is true) from the TermToBytesRefAttribute. C Tokenizer — A Tokenizer is a TokenStream whose input is a Reader. C TokenizerFactory — Abstract parent class for analysis factories that create Tokenizer instances. C WordlistLoader — Loader for text files that represent a list of stopwords.

org.apache.lucene.analysis.tokenattributes 24

I BytesTermAttribute — This attribute can be used if you have the raw term bytes to be indexed. C BytesTermAttributeImpl — Implementation class for BytesTermAttribute. I CharTermAttribute — The term text of a Token. C CharTermAttributeImpl — Default implementation of CharTermAttribute. I FlagsAttribute — This attribute can be used to pass different flags down the Tokenizer chain, e.g. C FlagsAttributeImpl — Default implementation of FlagsAttribute. I KeywordAttribute — This attribute can be used to mark a token as a keyword. C KeywordAttributeImpl — Default implementation of KeywordAttribute. I OffsetAttribute — The start and end character offset of a Token. C OffsetAttributeImpl — Default implementation of OffsetAttribute. C PackedTokenAttributeImpl — Default implementation of the common attributes used by Lucene: CharTermAttribute TypeAttribute PositionIncrementAttribute PositionLengthAttr I PayloadAttribute — The payload of a Token. C PayloadAttributeImpl — Default implementation of PayloadAttribute. I PositionIncrementAttribute — Determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching. C PositionIncrementAttributeImpl — Default implementation of PositionIncrementAttribute. I PositionLengthAttribute — Determines how many positions this token spans. C PositionLengthAttributeImpl — Default implementation of PositionLengthAttribute. I SentenceAttribute — This attribute tracks what sentence a given token belongs to as well as potentially other sentence specific attributes. C SentenceAttributeImpl — Default implementation of SentenceAttribute. I TermFrequencyAttribute — Sets the custom term frequency of a term within one document. C TermFrequencyAttributeImpl — Default implementation of TermFrequencyAttribute. I TermToBytesRefAttribute — This attribute is requested by TermsHashPerField to index the contents. I TypeAttribute — A Token's lexical type. C TypeAttributeImpl — Default implementation of TypeAttribute.

org.apache.lucene.codecs 40

C BlockTermState — Holds all state required for PostingsReaderBase to produce a org.apache.lucene.index.PostingsEnum without re-seeking the terms dict. C BufferingKnnVectorsWriter — Buffers up pending vector value(s) per doc, then flushes when segment flushes. C Codec — Encodes/decodes an inverted index segment. C CodecUtil — Utility class for reading and writing versioned headers. C CompetitiveImpactAccumulator — This class accumulates the (freq, norm) pairs that may produce competitive scores. C CompoundDirectory — A read-only Directory that consists of a view over a compound file. C CompoundFormat — Encodes/decodes compound files C DocValuesConsumer — Abstract API that consumes numeric, binary and sorted docvalues. C DocValuesFormat — Encodes/decodes per-document values. C DocValuesProducer — Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues. C FieldInfosFormat — Encodes/decodes FieldInfos C FieldsConsumer — Abstract API that consumes terms, doc, freq, prox, offset and payloads postings. C FieldsProducer — Abstract API that produces terms, doc, freq, prox, offset and payloads postings. C FilterCodec — A codec that forwards all its method calls to another codec. C Impact — Per-document scoring factors. C KnnFieldVectorsWriter — Vectors writer for a field. C KnnVectorsFormat — Encodes/decodes per-document vector and any associated indexing structures required to support nearest-neighbor search C KnnVectorsReader — Reads vectors from an index. C KnnVectorsWriter — Writes vectors to an index. C LiveDocsFormat — Format for live/deleted documents C MultiLevelSkipListReader — This abstract class reads skip lists with multiple levels. C MultiLevelSkipListWriter — This abstract class writes skip lists with multiple levels. C MutablePointTree — One leaf PointTree whose order of points can be changed. C NormsConsumer — Abstract API that consumes normalization values. C NormsFormat — Encodes/decodes per-document score normalization values. C NormsProducer — Abstract API that produces field normalization values C PointsFormat — Encodes/decodes indexed points. C PointsReader — Abstract API to visit point values. C PointsWriter — Abstract API to write points C PostingsFormat — Encodes/decodes terms, postings, and proximity data. C PostingsReaderBase — The core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation of org.apache.lucene.index.PostingsEnum and org.apache.lucene.index.ImpactsEnum instances. C PostingsWriterBase — Class that plugs into term dictionaries, such as Lucene103BlockTreeTermsWriter, and handles writing postings. C PushPostingsWriterBase — Extension of PostingsWriterBase, adding a push API for writing each element of the postings. C SegmentInfoFormat — Expert: Controls the format of the SegmentInfo (segment metadata file). C StoredFieldsFormat — Controls the format of stored fields C StoredFieldsReader — Codec API for reading stored fields. C StoredFieldsWriter — Codec API for writing stored fields: For every document, #startDocument() is called, informing the Codec that a new document has started. C TermVectorsFormat — Controls the format of term vectors C TermVectorsReader — Codec API for reading term vectors: C TermVectorsWriter — Codec API for writing term vectors: For every document, #startDocument(int) is called, informing the Codec how many fields will be written.

org.apache.lucene.codecs.hnsw.ScalarQuantizedVectorScorer 1

C ScalarQuantizedRandomVectorScorerSupplier — Quantized vector scorer supplier

org.apache.lucene.codecs.lucene104.Lucene104Codec 1

E Mode — Configuration option for the codec.

org.apache.lucene.codecs.lucene104.Lucene104ScalarQuantizedVectorsFormat 1

E ScalarEncoding — Allowed encodings for scalar quantization.

org.apache.lucene.codecs.lucene90.Lucene90StoredFieldsFormat 1

E Mode — Configuration option for stored fields.

org.apache.lucene.codecs.lucene95.OffHeapByteVectorValues 1

C DenseOffHeapVectorValues — Dense vector values that are stored off-heap.

org.apache.lucene.codecs.lucene95.OffHeapFloatVectorValues 1

C DenseOffHeapVectorValues — Dense vector values that are stored off-heap.

org.apache.lucene.document 56

C BinaryDocValuesField — Field that stores a per-document BytesRef value. C BinaryPoint — An indexed binary field for fast range filters. C BinaryRangeDocValues — A binary representation of a range that wraps a BinaryDocValues field C DateTools — Provides support for converting dates to strings and vice-versa. C Document — Documents are the unit of indexing and search. C DocumentStoredFieldVisitor — A StoredFieldVisitor that creates a Document from stored fields. C DoubleDocValuesField — Syntactic sugar for encoding doubles as NumericDocValues via Double#doubleToRawLongBits(double). C DoubleField — Field that stores a per-document double value for scoring, sorting or value retrieval and index the field for fast range filters. C DoublePoint — An indexed double field for fast range filters. C DoubleRange — An indexed Double Range field. C DoubleRangeDocValuesField — DocValues field for DoubleRange. C FeatureField — Field that can be used to store static scoring factors into documents. C Field — Expert: directly create a field for a document. C FieldType — Describes the properties of a field. C FloatDocValuesField — Syntactic sugar for encoding floats as NumericDocValues via Float#floatToRawIntBits(float). C FloatField — Field that stores a per-document float value for scoring, sorting or value retrieval and index the field for fast range filters. C FloatPoint — An indexed float field for fast range filters. C FloatRange — An indexed Float Range field. C FloatRangeDocValuesField — DocValues field for FloatRange. C InetAddressPoint — An indexed 128-bit InetAddress field. C InetAddressRange — An indexed InetAddress Range Field This field indexes an InetAddress range defined as a min/max pairs. C IntField — Field that stores a per-document int value for scoring, sorting or value retrieval and index the field for fast range filters. C IntPoint — An indexed int field for fast range filters. C IntRange — An indexed Integer Range field. C IntRangeDocValuesField — DocValues field for IntRange. E InvertableType — Describes how an IndexableField should be inverted for indexing terms and postings. C KeywordField — Field that indexes a per-document String or BytesRef into an inverted index for fast filtering, stores values in a columnar fashion using DocValuesType#SORTED_SET doc values for sorting and faceting, and optionally stores values as stored fields for top-hits retrieval. C KnnByteVectorField — A field that contains a single byte numeric vector (or none) for each document. C KnnFloatVectorField — A field that contains a single floating-point numeric vector (or none) for each document. C LatLonDocValuesField — An per-document location field. C LatLonPoint — An indexed location field. C LatLonShape — An geo shape utility class for indexing and searching gis geometries whose vertices are latitude, longitude values (in decimal degrees). C LatLonShapeDocValues — A concrete implementation of ShapeDocValues for storing binary doc value representation of LatLonShape geometries in a LatLonShapeDocValuesField Note: This class cannot be instantiated directly. C LatLonShapeDocValuesField — Concrete implementation of a ShapeDocValuesField for geographic geometries. C LateInteractionField — A field for storing multi-vector values for late interaction models. C LongField — Field that stores a per-document long value for scoring, sorting or value retrieval and index the field for fast range filters. C LongPoint — An indexed long field for fast range filters. C LongRange — An indexed Long Range field. C LongRangeDocValuesField — DocValues field for LongRange. C NumericDocValuesField — Field that stores a per-document long value for scoring, sorting or value retrieval. C RangeFieldQuery — Query class for searching RangeField types by a defined Relation. C ShapeDocValuesField — A doc values field for LatLonShape and XYShape that uses ShapeDocValues as the underlying binary doc value format. C ShapeField — A base shape utility class used for both LatLon (spherical) and XY (cartesian) shape fields. C SortedDocValuesField — Field that stores a per-document BytesRef value, indexed for sorting. C SortedNumericDocValuesField — Field that stores a per-document long values for scoring, sorting or value retrieval. C SortedSetDocValuesField — Field that stores a set of per-document BytesRef values, indexed for faceting,grouping,joining. C StoredField — A field whose value is stored so that IndexSearcher#storedFields and IndexReader#storedFields will return the field and its value. C StoredValue — Abstraction around a stored value. C StringField — A field that is indexed but not tokenized: the entire String value is indexed as a single token. C TextField — A field that is indexed and tokenized, without term vectors. C XYDocValuesField — An per-document location field. C XYDocValuesPointInGeometryQuery — XYGeometry query for XYDocValuesField. C XYPointField — An indexed XY position field. C XYShape — A cartesian shape utility class for indexing and searching geometries whose vertices are unitless x, y values. C XYShapeDocValues — A concrete implementation of ShapeDocValues for storing binary doc value representation of XYShape geometries in a XYShapeDocValuesField Note: This class cannot be instantiated directly. C XYShapeDocValuesField — Concrete implementation of a ShapeDocValuesField for cartesian geometries.

org.apache.lucene.document.DateTools 1

E Resolution — Specifies the time granularity.

org.apache.lucene.document.ShapeField.DecodedTriangle 1

E TYPE — type of triangle

org.apache.lucene.document.StoredValue 1

E Type — Type of a StoredValue.

org.apache.lucene.geo.SimpleWKTShapeParser 1

E ShapeType — Enumerated type for Shapes

org.apache.lucene.index 131

C AutomatonTermsEnum — A FilteredTermsEnum that enumerates terms based upon what is accepted by a DFA. C BaseCompositeReader — Base class for implementing CompositeReaders based on an array of sub-readers. C BaseTermsEnum — A base TermsEnum that adds default implementations for #attributes() #termState() #seekExact(BytesRef) #seekExact(BytesRef, TermState) In s C BinaryDocValues — A per-document numeric value. C ByteVectorValues — This class provides access to per-document floating point vector values indexed as KnnByteVectorField. C CheckIndex — Basic tool and API to check the health of an index and write a new segments file that removes reference to problematic segments. C CodecReader — LeafReader implemented by codec APIs. C CompositeReader — Instances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings. C CompositeReaderContext — IndexReaderContext for CompositeReader instance. C ConcurrentMergeScheduler — A MergeScheduler that runs each merge using a separate thread. C CorruptIndexException — This exception is thrown when Lucene detects an inconsistency in the index. C DirectoryReader — DirectoryReader is an implementation of CompositeReader that can read indexes in a Directory. C DocIDMerger — Utility class to help merging documents from sub-readers according to either simple concatenated (unsorted) order, or by a specified index-time sort, s C DocValues — This class contains utility methods and constants for DocValues E DocValuesSkipIndexType — Options for skip indexes on doc values. C DocValuesSkipper — Skipper for DocValues. E DocValuesType — DocValues types. C DocsWithFieldSet — Accumulator for documents that have a value for a field. C EmptyDocValuesProducer — Abstract base class implementing a DocValuesProducer that has no doc values. C ExitableDirectoryReader — The ExitableDirectoryReader wraps a real index DirectoryReader and allows for a QueryTimeout implementation object to be checked periodically to see if the thread should exit or not. C FieldInfo — Access to the Field Info file that describes document fields and whether or not they are indexed. C FieldInfos — Collection of FieldInfos (accessible by number or by name). C FieldInvertState — This class tracks the number and position / offset parameters of terms being added to the index. C Fields — Provides a Terms index for fields that have it, and lists which fields do. C FilterBinaryDocValues — Delegates all methods to a wrapped BinaryDocValues. C FilterCodecReader — A FilterCodecReader contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. C FilterDirectoryReader — A FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it. C FilterLeafReader — A FilterLeafReader contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. C FilterMergePolicy — A wrapper for MergePolicy instances. C FilterNumericDocValues — Delegates all methods to a wrapped NumericDocValues. C FilterSortedDocValues — Delegates all methods to a wrapped SortedDocValues. C FilterSortedNumericDocValues — Delegates all methods to a wrapped SortedNumericDocValues. C FilterSortedSetDocValues — Delegates all methods to a wrapped SortedSetDocValues. C FilteredTermsEnum — Abstract class for enumerating a subset of all terms. C FloatVectorValues — This class provides access to per-document floating point vector values indexed as KnnFloatVectorField. C FreqAndNormBuffer — Wrapper around parallel arrays storing term frequencies and length normalization factors. C Impacts — Information about upcoming impacts, ie. C ImpactsEnum — Extension of PostingsEnum which also provides information about upcoming impacts. I ImpactsSource — Source of Impacts. C IndexCommit — Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader. C IndexDeletionPolicy — Expert: policy for deletion of stale index commits. C IndexFileNames — This class contains useful constants representing filenames and extensions used by lucene, as well as convenience methods for querying whether a file name matches an extension (matchesExtension), as well as generating file names from a segment name, generation and extension ( fileNameFromGeneration, segmentFileName). C IndexFormatTooNewException — This exception is thrown when Lucene detects an index that is newer than this Lucene version. C IndexFormatTooOldException — This exception is thrown when Lucene detects an index that is too old for this Lucene version C IndexNotFoundException — Signals that no index was found in the Directory. E IndexOptions — Controls how much information is stored in the postings lists. C IndexReader — IndexReader is an abstract class, providing an interface for accessing a point-in-time view of an index. C IndexReaderContext — A struct like class that represents a hierarchical relationship between IndexReader instances. I IndexSorter — Handles how documents should be sorted in an index, both within a segment and between segments. C IndexUpgrader — This is an easy-to-use tool that upgrades all segments of an index from previous Lucene versions to the current segment file format. C IndexWriter — An IndexWriter creates and maintains an index. C IndexWriterConfig — Holds all the configuration that is used to create an IndexWriter. I IndexWriterEventListener — A callback event listener for recording key events happened inside IndexWriter I IndexableField — Represents a single field for indexing. I IndexableFieldType — Describes the properties of a field. C KeepLastNCommitsDeletionPolicy — This IndexDeletionPolicy implementation keeps the last N commits and removes all prior commits after a new commit is done. C KeepOnlyLastCommitDeletionPolicy — This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done. C KnnVectorValues — This class abstracts addressing of document vector values indexed as KnnFloatVectorField or KnnByteVectorField. C LeafReader — LeafReader is an abstract class, providing an interface for accessing an index. C LeafReaderContext — IndexReaderContext for LeafReader instances. C LiveIndexWriterConfig — Holds all the configuration used by IndexWriter with few setters for settings that can be changed on an IndexWriter instance "live". C LogByteSizeMergePolicy — This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's files. C LogDocMergePolicy — This is a LogMergePolicy that measures size of a segment as the number of documents (not taking deletions into account). C LogMergePolicy — This class implements a MergePolicy that tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor. C MappedMultiFields — A Fields implementation that merges multiple Fields into one, and maps around deleted documents. C MergePolicy — Expert: a MergePolicy determines the sequence of primitive merge operations. C MergeRateLimiter — This is the RateLimiter that IndexWriter assigns to each running merge, to give MergeSchedulers ionice like control. C MergeScheduler — Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy. C MergeState — Holds common state used during segment merging. E MergeTrigger — MergeTrigger is passed to MergePolicy#findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext) to indicate the event that triggered the merge. C MultiBits — Concatenates multiple Bits together, on every lookup. C MultiDocValues — A wrapper for CompositeIndexReader providing access to DocValues. C MultiFields — Provides a single Fields term index view over an IndexReader. C MultiLeafReader — Utility methods for working with a IndexReader as if it were a LeafReader. C MultiPostingsEnum — Exposes PostingsEnum, merged from PostingsEnum API of sub-segments. C MultiReader — A CompositeReader which reads multiple indexes, appending their content. C MultiTerms — Exposes flex API, merged from flex API of sub-segments. C MultiTermsEnum — Exposes TermsEnum API, merged from TermsEnum API of sub-segments. C NoDeletionPolicy — An IndexDeletionPolicy which keeps all index commits around, never deleting them. C NoMergePolicy — A MergePolicy which never returns merges to execute. C NoMergeScheduler — A MergeScheduler which never executes any merges. C NumericDocValues — A per-document numeric value. C OneMergeWrappingMergePolicy — A wrapping merge policy that wraps the org.apache.lucene.index.MergePolicy.OneMerge objects returned by the wrapped merge policy. C OrdTermState — An ordinal based TermState C OrdinalMap — Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation. C ParallelCompositeReader — An CompositeReader which reads multiple, parallel indexes. C ParallelLeafReader — An LeafReader which reads multiple, parallel indexes. C PersistentSnapshotDeletionPolicy — A SnapshotDeletionPolicy which adds a persistence layer so that snapshots can be maintained across the life of an application. C PointValues — Access to indexed numeric values. C PostingsEnum — Iterates through the postings. C PrefixCodedTerms — Prefix codes term instances (prefixes are shared). I QueryTimeout — Query timeout abstraction that controls whether a query should continue or be stopped. C QueryTimeoutImpl — An implementation of QueryTimeout that can be used by the ExitableDirectoryReader class to time out and exit out when a query takes a long time to rewr C ReaderManager — Utility class to safely share DirectoryReader instances across multiple threads, while periodically reopening. C ReaderUtil — Common util methods for dealing with IndexReaders and IndexReaderContexts. C SegmentCommitInfo — Embeds a [read-only] SegmentInfo and adds per-commit fields. C SegmentInfo — Information about a segment such as its name, directory, and files related to the segment. C SegmentInfos — A collection of segmentInfo objects with methods for operating on those segments in relation to the file system. C SegmentOrder — Utility class to re-order segments within an IndexReader to assist in early termination. C SegmentReadState — Holder class for common parameters used during read. C SegmentReader — IndexReader implementation over a single segment. C SegmentWriteState — Holder class for common parameters used during write. C SerialMergeScheduler — A MergeScheduler that simply does each merge sequentially, using the current thread. C SimpleMergedSegmentWarmer — A very simple merged segment warmer that just ensures data structures are initialized. C SingleTermsEnum — Subclass of FilteredTermsEnum for enumerating a single term. C SlowCodecReaderWrapper — Wraps arbitrary readers for merging. C SlowImpactsEnum — ImpactsEnum that doesn't index impacts but implements the API in a legal way. C SnapshotDeletionPolicy — An IndexDeletionPolicy that wraps any other IndexDeletionPolicy and adds the ability to hold and later release snapshots of an index. C SoftDeletesDirectoryReaderWrapper — This reader filters out documents that have a doc values value in the given field and treat these documents as soft deleted. C SoftDeletesRetentionMergePolicy — This MergePolicy allows to carry over soft deleted documents across merges. C SortFieldProvider — Reads/Writes a named SortField from a segment info file, used to record index sorts C SortedDocValues — A per-document byte[] with presorted values. C SortedNumericDocValues — A list of per-document numeric values, sorted according to Long#compare(long, long). C SortedSetDocValues — A multi-valued version of SortedDocValues. C Sorter — Sorts documents of a given index by returning a permutation on the document IDs. C SortingCodecReader — An org.apache.lucene.index.CodecReader which supports sorting documents by a given Sort. C StandardDirectoryReader — Default implementation of DirectoryReader. C StoredFieldVisitor — Expert: provides a low-level means of accessing the stored field values in an index. C StoredFields — API for reading stored fields. C Term — A Term represents a word from text. C TermState — Encapsulates all required internal state to position the associated TermsEnum without re-seeking. C TermStates — Maintains a IndexReader TermState view over IndexReader instances containing a single term. C TermVectors — API for reading term vectors. C Terms — Access to the terms in a specific field. C TermsEnum — Iterator to seek (#seekCeil(BytesRef), #seekExact(BytesRef)) or step through (#next terms to obtain frequency information (#docFreq), PostingsEnum or PostingsEnum for the current term (#postings. C TieredMergePolicy — Merges segments of approximately equal size, subject to an allowed number of segments per tier. I TwoPhaseCommit — An interface for implementations that support 2-phase commit. C TwoPhaseCommitTool — A utility for executing 2-phase commit on several objects. C UpgradeIndexMergePolicy — This MergePolicy is used for upgrading all existing segments of an index when calling IndexWriter#forceMerge(int). E VectorEncoding — The numeric datatype of the vector values. E VectorSimilarityFunction — Vector similarity function; used in search to return top K most similar vectors to a target vector.

org.apache.lucene.index.DocIDMerger 1

C Sub — Represents one sub-reader being merged

org.apache.lucene.index.IndexWriterConfig 1

E OpenMode — Specifies the open mode for IndexWriter.

org.apache.lucene.index.MergePolicy.OneMergeProgress 1

E PauseReason — Reason for pausing the merge thread.

org.apache.lucene.index.MergeState 1

I DocMap — A map of doc IDs.

org.apache.lucene.index.Sorter 1

C DocMap — A permutation of doc IDs.

org.apache.lucene.search 162

C AbstractDocIdSetIterator — Abstract implementation of a DocIdSetIterator that tracks the current doc ID. C AbstractKnnCollector — AbstractKnnCollector is the default implementation for a knn collector used for gathering kNN results and providing topDocs from the gathered neighbors C AcceptDocs — Higher-level abstraction for document acceptance filtering. C AutomatonQuery — A Query that will match terms against a finite-state machine. C BlendedTermQuery — A Query that blends index statistics across multiple terms. C BooleanQuery — A Query that matches documents matching boolean combinations of other queries, e.g. I BoostAttribute — Add this Attribute to a TermsEnum returned by MultiTermQuery#getTermsEnum(Terms,AttributeSource) and update the boost on each returned term. C BoostAttributeImpl — Implementation class for BoostAttribute. C BoostQuery — A Query wrapper that allows to give a boost to the wrapped query. C BulkScorer — This class is used to score a range of documents at once, and is returned by Weight#bulkScorer. C ByteVectorSimilarityQuery — Search for all (approximate) byte vectors above a similarity threshold. C CachingCollector — Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector. I CheckedIntConsumer — Like IntConsumer, but may throw checked exceptions. C CollectionTerminatedException — Throw this exception in LeafCollector#collect(int) to prematurely terminate collection of the current leaf. I Collector — Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. I CollectorManager — A manager of collectors. C CombinedFieldQuery — A Query that treats multiple fields as a single stream and scores terms as if they had been indexed in a single field whose values would be the union of the values of the provided fields. C ConjunctionUtils — Helper methods for building conjunction iterators C ConstantScoreQuery — A query that wraps another query and simply returns a constant score equal to 1 for every document that matches the query. C ConstantScoreScorer — A constant-scoring Scorer. C ConstantScoreScorerSupplier — Specialization of ScorerSupplier for queries that produce constant scores. C ConstantScoreWeight — A Weight that has a constant score equal to the boost of the wrapped query. C ControlledRealTimeReopenThread — Utility class that runs a thread to manage periodicc reopens of a ReferenceManager, with methods to wait for a specific index changes to become visible. C DisiPriorityQueue — A priority queue of DocIdSetIterators that orders by current doc ID. C DisiWrapper — Wrapper used in DisiPriorityQueue. C DisjunctionDISIApproximation — A DocIdSetIterator which is a disjunction of the approximations of the provided iterators. C DisjunctionMaxQuery — A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries. C DocAndFloatFeatureBuffer — Wrapper around parallel arrays storing doc IDs and their corresponding features, stored as Java floats. C DocAndScoreAccBuffer — Wrapper around parallel arrays storing doc IDs and their corresponding score accumulators. C DocIdSet — A DocIdSet contains a set of doc ids. C DocIdSetBulkIterator — Bulk iterator over a DocIdSetIterator. C DocIdSetIterator — This abstract class defines methods to iterate over a set of non-decreasing doc ids. C DocIdStream — A stream of doc IDs. C DocValuesRangeIterator — Wrapper around a TwoPhaseIterator for a doc-values range query that speeds things up by taking advantage of a DocValuesSkipper. C DocValuesRewriteMethod — Rewrites MultiTermQueries into a filter, using DocValues for term enumeration. C DoubleValues — Per-segment, per-document double values, which can be calculated at search-time C DoubleValuesSource — Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call #rewrite(IndexSearcher) against the top-level searcher, and then call #getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource. C DoubleValuesSourceRescorer — A Rescorer that uses provided DoubleValuesSource to rescore first pass hits. C ExactPhraseMatcher — Expert: Find exact phrases C Explanation — Expert: Describes the score computation for document and query. C FieldComparator — Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector. C FieldComparatorSource — Provides a FieldComparator for custom field sorting. C FieldDoc — Expert: A ScoreDoc which also contains information about how to sort the referenced document. C FieldExistsQuery — A Query that matches documents that contain either a KnnFloatVectorField, org.apache.lucene.document.KnnByteVectorField or a field that indexes norms o C FieldValueHitQueue — Expert: A hit queue for sorting by hits by terms in more than one field. C FilterCollector — Collector delegator. C FilterDocIdSetIterator — Wrapper around a DocIdSetIterator. C FilterLeafCollector — LeafCollector delegator. C FilterMatchesIterator — A MatchesIterator that delegates all calls to another MatchesIterator C FilterScorable — Filter a Scorable, intercepting methods and optionally changing their return values The default implementation simply passes all calls to its delegate C FilterScorer — A FilterScorer contains another Scorer, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. C FilterWeight — A FilterWeight contains another Weight and implements all abstract methods by calling the contained weight's method. C FilteredDocIdSetIterator — Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. C FloatVectorSimilarityQuery — Search for all (approximate) float vectors above a similarity threshold. C FullPrecisionFloatVectorSimilarityValuesSource — A DoubleValuesSource that computes vector similarity between a query vector and raw full precision vectors indexed in provided org.apache.lucene.docume C FuzzyQuery — Implements the fuzzy search query. C FuzzyTermsEnum — Subclass of TermsEnum for enumerating all terms that are similar to the specified filter term. C HitQueue — Expert: Priority queue containing hit docs C HnswQueueSaturationCollector — A KnnCollector.Decorator that early exits when nearest neighbor queue keeps saturating beyond a 'patience' parameter. C ImpactsDISI — DocIdSetIterator that skips non-competitive docs thanks to the indexed impacts. C IndexOrDocValuesQuery — A query that uses either an index structure (points or terms) or doc values in order to run a query, depending which one is more efficient. C IndexSearcher — Implements search over a single IndexReader. C IndexSortSortedNumericDocValuesRangeQuery — A range query that can take advantage of the fact that the index is sorted to speed up execution. C IndriAndQuery — A Query that matches documents matching combinations of subqueries. C IndriAndScorer — Combines scores of subscorers. C IndriAndWeight — The Weight for IndriAndQuery, used to normalize, score and explain these queries. C IndriDisjunctionScorer — The Indri implemenation of a disjunction scorer which stores the subscorers for the child queries. C IndriQuery — A Basic abstract query that all IndriQueries can extend to implement toString, equals, getClauses, and iterator. C IndriScorer — The Indri parent scorer that stores the boost so that IndriScorers can use the boost outside of the term. C KnnByteVectorQuery — Uses KnnVectorsReader#search(String, byte[], KnnCollector, AcceptDocs) to perform nearest neighbour search. I KnnCollector — KnnCollector is a knn collector used for gathering kNN results and providing topDocs from the gathered neighbors C KnnFloatVectorQuery — Uses KnnVectorsReader#search(String, float[], KnnCollector, AcceptDocs) to perform nearest neighbour search. C LRUQueryCache — A QueryCache that evicts queries using a LRU (least-recently-used) eviction policy in order to remain under a given maximum size and number of bytes used. C LateInteractionFloatValuesSource — A DoubleValuesSource that scores documents using similarity between a multi-vector query, and indexed document multi-vectors. C LateInteractionRescorer — Rescores top N results from a first pass query using a LateInteractionFloatValuesSource Typically, you run a low-cost first pass query to collect results from across the index, then use this rescorer to rerank top N hits using multi-vectors, usually from a late interaction model. I LeafCollector — Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed. I LeafFieldComparator — Expert: comparator that gets instantiated on each leaf from a top-level FieldComparator instance. C LiveFieldValues — Tracks live field values across NRT reader reopens. C LongValues — Per-segment, per-document long values, which can be calculated at search-time C LongValuesSource — Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call #rewrite(IndexSearcher) against the top-level searcher, and then #getValues(LeafReaderContext, DoubleValues). C MatchAllDocsQuery — A query that matches all documents. C MatchNoDocsQuery — A query that matches no documents. I Matches — Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain a MatchesIterator for a particular field, call #getMatches(String). I MatchesIterator — An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call #next() until it returns false, retrieving positions and/or offsets after each call. C MatchesUtils — Contains static functions that aid the implementation of Matches and MatchesIterator interfaces. I MaxNonCompetitiveBoostAttribute — Add this Attribute to a fresh AttributeSource before calling MultiTermQuery#getTermsEnum(Terms,AttributeSource). C MaxNonCompetitiveBoostAttributeImpl — Implementation class for MaxNonCompetitiveBoostAttribute. C MaxScoreCache — Compute maximum scores based on Impacts and keep them in a cache in order not to run expensive similarity score computations multiple times on the same C MultiCollector — A Collector which allows running a search with several Collectors. C MultiCollectorManager — A CollectorManager implements which wrap a set of CollectorManager as MultiCollector acts for Collector. C MultiPhraseQuery — A generalized version of PhraseQuery, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR). C MultiTermQuery — An abstract Query that matches documents containing a subset of terms provided by a FilteredTermsEnum enumeration. I MultiVectorSimilarity — Interface to define the similarity function between multi-vectors C Multiset — A Multiset is a set that allows for duplicate elements. C NGramPhraseQuery — This is a PhraseQuery which is optimized for n-gram phrase query. C NamedMatches — Utility class to help extract the set of sub queries that have matched from a larger query. C NumericDocValuesRangeQuery — A Query over a range of long values C PatienceKnnVectorQuery — This is a version of knn vector query that exits early when HNSW queue saturates over a #saturationThreshold for more than #patience times. C PhraseMatcher — Base class for exact and sloppy phrase matching To find matches on a document, first advance #approximation to the relevant document, then call #reset(). C PhraseQuery — A Query that matches documents containing a particular sequence of terms. C PhraseWeight — Expert: Weight class for phrase matching C PointInSetQuery — Abstract query class to find all documents whose single or multi-dimensional point values, previously indexed with e.g. C PointRangeQuery — Abstract class for range queries against single or multidimensional points such as IntPoint. C PositiveScoresOnlyCollector — A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected. C PrefixQuery — A Query that matches documents containing terms with a specified prefix. E Pruning — Controls LeafFieldComparator how to skip documents C Query — The abstract base class for queries. I QueryCache — A cache for queries. I QueryCachingPolicy — A policy defining which filters should be cached. C QueryRescorer — A Rescorer that uses a provided Query to assign scores to the first-pass hits. C QueryVisitor — Allows recursion through a query tree C ReferenceManager — Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them. I RefreshCommitSupplier — Expert: Interface to supply commit for searcher refresh. C RegexpQuery — A fast regular expression query based on the org.apache.lucene.util.automaton package. C RescoreTopNQuery — A Query that re-scores another Query with a DoubleValuesSource function and cut-off the results at top N. C Rescorer — Re-scores the topN results (TopDocs) from an original query. C Scorable — Allows access to the score of a Query C ScoreCachingWrappingScorer — A Scorer which wraps another scorer and caches the score of the current document. C ScoreDoc — Holds one hit in TopDocs. E ScoreMode — Different modes of search. C Scorer — Expert: Common scoring functionality for different types of queries. C ScorerSupplier — A supplier of Scorer. C ScoringRewrite — Base rewrite method that translates each term into a query, and keeps the scores as computed by the query. C SearcherFactory — Factory class used by SearcherManager to create new IndexSearchers. C SearcherLifetimeManager — Keeps track of current plus old IndexSearchers, closing the old ones once they have timed out. C SearcherManager — Utility class to safely share IndexSearcher instances across multiple threads, while periodically reopening. C SeededKnnVectorQuery — This is a version of knn vector query that provides a query seed to initiate the vector search. I SegmentCacheable — Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from #isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues#isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated. C SimpleCollector — Base Collector implementation that is used to collect all contexts. C SimpleFieldComparator — Base FieldComparator implementation that is used for all contexts. C SkipBlockRangeIterator — A DocIdSetIterator that returns all documents within DocValuesSkipper blocks that have minimum and maximum values that fall within a specified range. C SloppyPhraseMatcher — Find all slop-valid position-combinations (matches) encountered while traversing/hopping the PhrasePositions. C Sort — Encapsulates sort criteria for returned hits. C SortField — Stores information about how to sort documents by terms in an individual field. C SortRescorer — A Rescorer that re-sorts according to a provided Sort. C SortedNumericSelector — Selects a value from the document's list to use as the representative value This provides a NumericDocValues view over the SortedNumeric, for use with C SortedNumericSortField — SortField for SortedNumericDocValues. C SortedSetSelector — Selects a value from the document's set to use as the representative value C SortedSetSortField — SortField for SortedSetDocValues. C SynonymQuery — A query that treats multiple terms as synonyms. C TaskExecutor — Executor wrapper responsible for the execution of concurrent tasks. C TermInSetQuery — Specialization for a disjunction over many terms that, by default, behaves like a ConstantScoreQuery over a BooleanQuery containing only org.apache.lucene.search.BooleanClause.Occur#SHOULD clauses. C TermQuery — A Query that matches documents containing a term. C TermRangeQuery — A Query that matches documents within an range of terms. C TermScorer — Expert: A Scorer for documents matching a Term. C TimeLimitingKnnCollectorManager — A KnnCollectorManager that collects results with a timeout. C TopDocs — Represents hits returned by IndexSearcher#search(Query,int). C TopDocsCollector — A base class for all collectors that return a TopDocs output. C TopFieldCollector — A Collector that sorts by SortField using FieldComparators. C TopFieldCollectorManager — Create a TopFieldCollectorManager which uses a shared hit counter to maintain number of hits and a shared MaxScoreAccumulator to propagate the minimum score across segments if the primary sort is by relevancy. C TopFieldDocs — Represents hits returned by IndexSearcher#search(Query,int,Sort). C TopKnnCollector — TopKnnCollector is a specific KnnCollector. C TopScoreDocCollector — A Collector implementation that collects the top-scoring hits, returning them as a TopDocs. C TopScoreDocCollectorManager — Create a TopScoreDocCollectorManager which uses a shared hit counter to maintain number of hits and a shared MaxScoreAccumulator to propagate the minim C TopTermsRewrite — Base rewrite method for collecting only the top terms via a priority queue. C TotalHitCountCollector — Just counts the total number of hits. C TotalHitCountCollectorManager — Collector manager based on TotalHitCountCollector that allows users to parallelize counting the number of hits, expected to be used mostly wrapped in MultiCollectorManager. C TwoPhaseIterator — Returned by Scorer#twoPhaseIterator() to expose an approximation of a DocIdSetIterator. C UsageTrackingQueryCachingPolicy — A QueryCachingPolicy that tracks usage statistics of recently-used filters in order to decide on which filters are worth caching. I VectorScorer — Computes the similarity score between a given query vector and different document vectors. C Weight — Expert: Calculate query weights and build query scorers. C WildcardQuery — Implements the wildcard search query.

org.apache.lucene.search.BooleanQuery 1

C Builder — A builder for boolean queries.

org.apache.lucene.search.CombinedFieldQuery 1

C Builder — A builder for CombinedFieldQuery.

org.apache.lucene.search.PointInSetQuery 1

C Stream — Iterator of encoded point values.

org.apache.lucene.search.SortedNumericSelector 1

E Type — Type of selection to perform.

org.apache.lucene.search.SortedNumericSortField 1

C Provider — A SortFieldProvider for this sort field

org.apache.lucene.search.SortedSetSelector 1

E Type — Type of selection to perform.

org.apache.lucene.search.SortedSetSortField 1

C Provider — A SortFieldProvider for this sort

org.apache.lucene.search.SynonymQuery 1

C Builder — A builder for SynonymQuery.

org.apache.lucene.search.similarities 47

C AfterEffect — This class acts as the base class for the implementations of the first normalization of the informative content in the DFR framework. C AfterEffectB — Model of the information gain based on the ratio of two Bernoulli processes. C AfterEffectL — Model of the information gain based on Laplace's law of succession. C Axiomatic — Axiomatic approaches for IR. C AxiomaticF1EXP — F1EXP is defined as Sum(tf(term_doc_freq)*ln(docLen)*IDF(term)) where IDF(t) = pow((N+1)/df(t), k) N=total num of docs, df=doc freq C AxiomaticF1LOG — F1LOG is defined as Sum(tf(term_doc_freq)*ln(docLen)*IDF(term)) where IDF(t) = ln((N+1)/df(t)) N=total num of docs, df=doc freq C AxiomaticF2EXP — F2EXP is defined as Sum(tfln(term_doc_freq, docLen)*IDF(term)) where IDF(t) = pow((N+1)/df(t), k) N=total num of docs, df=doc freq C AxiomaticF2LOG — F2EXP is defined as Sum(tfln(term_doc_freq, docLen)*IDF(term)) where IDF(t) = ln((N+1)/df(t)) N=total num of docs, df=doc freq C AxiomaticF3EXP — F3EXP is defined as Sum(tf(term_doc_freq)*IDF(term)-gamma(docLen, queryLen)) where IDF(t) = pow((N+1)/df(t), k) N=total num of docs, df=doc freq gamma( C AxiomaticF3LOG — F3EXP is defined as Sum(tf(term_doc_freq)*IDF(term)-gamma(docLen, queryLen)) where IDF(t) = ln((N+1)/df(t)) N=total num of docs, df=doc freq gamma(docL C BM25Similarity — BM25 Similarity. C BasicModel — This class acts as the base class for the specific basic model implementations in the DFR framework. C BasicModelG — Geometric as limiting form of the Bose-Einstein model. C BasicModelIF — An approximation of the I(ne) model. C BasicModelIn — The basic tf-idf model of randomness. C BasicModelIne — Tf-idf model of randomness, based on a mixture of Poisson and inverse document frequency. C BasicStats — Stores all statistics commonly used ranking methods. C BooleanSimilarity — Simple similarity that gives terms a score that is equal to their query boost. C ClassicSimilarity — Expert: Historical scoring implementation. C DFISimilarity — Implements the Divergence from Independence (DFI) model based on Chi-square statistics (i.e., standardized Chi-squared distance from independence in term frequency tf). C DFRSimilarity — Implements the divergence from randomness (DFR) framework introduced in Gianni Amati and Cornelis Joost Van Rijsbergen. C Distribution — The probabilistic distribution used to model term occurrence in information-based models. C DistributionLL — Log-logistic distribution. C DistributionSPL — The smoothed power-law (SPL) distribution for the information-based framework that is described in the original paper. C IBSimilarity — Provides a framework for the family of information-based models, as described in Stéphane Clinchant and Eric Gaussier. C Independence — Computes the measure of divergence from independence for DFI scoring functions. C IndependenceChiSquared — Normalized chi-squared measure of distance from independence Described as: "can be used for tasks that require high precision, against both short and C IndependenceSaturated — Saturated measure of distance from independence Described as: "for tasks that require high recall against long queries" C IndependenceStandardized — Standardized measure of distance from independence Described as: "good at tasks that require high recall and high precision, especially against short C IndriDirichletSimilarity — Bayesian smoothing using Dirichlet priors as implemented in the Indri Search engine (http://www.lemurproject.org/indri.php). C LMDirichletSimilarity — Bayesian smoothing using Dirichlet priors. C LMJelinekMercerSimilarity — Language model based on the Jelinek-Mercer smoothing method. C LMSimilarity — Abstract superclass for language modeling Similarities. C Lambda — The lambda (λw) parameter in information-based models. C LambdaDF — Computes lambda as docFreq+1 / numberOfDocuments+1. C LambdaTTF — Computes lambda as totalTermFreq+1 / numberOfDocuments+1. C MultiSimilarity — Implements the CombSUM method for combining evidence from multiple similarity values described in: Joseph A. C Normalization — This class acts as the base class for the implementations of the term frequency normalization methods in the DFR framework. C NormalizationH1 — Normalization model that assumes a uniform distribution of the term frequency. C NormalizationH2 — Normalization model in which the term frequency is inversely related to the length. C NormalizationH3 — Dirichlet Priors normalization C NormalizationZ — Pareto-Zipf Normalization C PerFieldSimilarityWrapper — Provides the ability to use a different Similarity for different fields. C RawTFSimilarity — Similarity that returns the raw TF as score. C Similarity — Similarity defines the components of Lucene scoring. C SimilarityBase — A subclass of Similarity that provides a simplified API for its descendants. C TFIDFSimilarity — Implementation of Similarity with the Vector Space Model.

org.apache.lucene.search.similarities.Normalization 1

C NoNormalization — Implementation used when there is no normalization.

org.apache.lucene.store 54

C AlreadyClosedException — This exception is thrown when there is an attempt to access something that has already been closed. C BaseDirectory — Base implementation for a concrete Directory that uses a LockFactory for locking. C BufferedChecksum — Wraps another Checksum with an internal buffer to speed up checksum calculations. C BufferedChecksumIndexInput — Simple implementation of ChecksumIndexInput that wraps another input and delegates calls. C BufferedIndexInput — Base implementation class for buffered IndexInput. C ByteArrayDataInput — DataInput backed by a byte array. C ByteArrayDataOutput — DataOutput backed by a byte array. C ByteBuffersDataInput — A DataInput implementing RandomAccessInput and reading data from a list of ByteBuffers. C ByteBuffersDataOutput — A DataOutput storing data in a list of ByteBuffers. C ByteBuffersDirectory — A ByteBuffer-based Directory implementation that can be used to store index files on the heap. C ByteBuffersIndexInput — An IndexInput implementing RandomAccessInput and backed by a ByteBuffersDataInput. C ByteBuffersIndexOutput — An IndexOutput writing to a ByteBuffersDataOutput. C ChecksumIndexInput — Extension of IndexInput, computing checksum as it goes. E DataAccessHint — Hint on the data access pattern likely to be used C DataInput — Abstract base class for performing read operations of Lucene's low-level data types. C DataOutput — Abstract base class for performing write operations of Lucene's low-level data types. C Directory — A Directory provides an abstraction layer for storing a list of files. C FSDirectory — Base class for Directory implementations that store index files in the file system. C FSLockFactory — Base class for file system based locking implementation. E FileDataHint — Hints on the type of data stored in the file C FileSwitchDirectory — Expert: A Directory instance that switches files between two other Directory instances. E FileTypeHint — Hints on the type of file being opened. C FilterDirectory — Directory implementation that delegates calls to another directory. C FilterIndexInput — IndexInput implementation that delegates calls to another directory. C FilterIndexOutput — IndexOutput implementation that delegates calls to another directory. I IOContext — IOContext holds additional details on the merge/search context. C IndexInput — Abstract base class for input from a file in a Directory. C IndexOutput — A DataOutput for appending data to a file in a Directory. C InputStreamDataInput — A DataInput wrapping a plain InputStream. C Lock — An interprocess mutex lock. C LockFactory — Base class for Locking implementation. C LockObtainFailedException — This exception is thrown when the write.lock could not be acquired. C LockReleaseFailedException — This exception is thrown when the write.lock could not be released. C LockStressTest — Simple standalone tool that forever acquires and releases a lock using a specific LockFactory. C LockValidatingDirectoryWrapper — This class makes a best-effort check that a provided Lock is valid before any destructive filesystem operation. C LockVerifyServer — Simple standalone server that must be running when you use VerifyingLockFactory. C MMapDirectory — File-based Directory implementation that uses mmap for reading, and FSDirectory.FSIndexOutput for writing. C NIOFSDirectory — An FSDirectory implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing. C NRTCachingDirectory — Wraps a RAM-resident directory around any provided delegate directory, to be used during NRT search. C NativeFSLockFactory — Implements LockFactory using native OS file locks. C NoLockFactory — Use this LockFactory to disable locking entirely. C OutputStreamDataOutput — A DataOutput wrapping a plain OutputStream. C OutputStreamIndexOutput — Implementation class for buffered IndexOutput that writes to an OutputStream. E PreloadHint — A hint that the file should be preloaded into memory I RandomAccessInput — Random Access Index API. C RateLimitedIndexOutput — A rate limiting IndexOutput C RateLimiter — Abstract base class to rate limit IO. E ReadAdvice — Advice regarding the read access pattern. E ReadOnceHint — A IOContext.FileOpenHint indicating the file will only be read once, sequentially C SimpleFSLockFactory — Implements LockFactory using Files#createFile. C SingleInstanceLockFactory — Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance. C SleepingLockWrapper — Directory that wraps another, and that sleeps and retries if obtaining the lock fails. C TrackingDirectoryWrapper — A delegating Directory that records which files were written to and deleted. C VerifyingLockFactory — A LockFactory that wraps another LockFactory and verifies that each lock obtain/release is "correct" (never results in two processes holding the lock at the same time).

org.apache.lucene.store.RateLimiter 1

C SimpleRateLimiter — Simple class to rate limit IO.

org.apache.lucene.util 107

I Accountable — An object whose RAM usage can be computed. C Accountables — Helper methods for constructing nested resource descriptions and debugging RAM usage. C ArrayUtil — Methods for manipulating arrays. I Attribute — Base interface for attributes. C AttributeFactory — An AttributeFactory creates instances of AttributeImpls. C AttributeImpl — Base class for Attributes that can be added to a org.apache.lucene.util.AttributeSource. I AttributeReflector — This interface is used to reflect contents of AttributeSource or AttributeImpl. C AttributeSource — An AttributeSource contains a list of different AttributeImpls, and methods to add and get them. C BitDocIdSet — Implementation of the DocIdSet interface on top of a BitSet. C BitSet — Base implementation for a bit set. C BitSetIterator — A DocIdSetIterator which iterates over set bits in a bit set. C BitUtil — A variety of high efficiency bit twiddling routines and encoders for primitives. I Bits — Interface for Bitset-like structures. C ByteBlockPool — This class enables the allocation of fixed-size buffers and their management as part of a buffer array. C BytesRef — Represents byte[], as a slice (offset + length) into an existing byte[]. C BytesRefArray — A simple append only random-access BytesRef array that stores full copies of the appended bytes in a ByteBlockPool. C BytesRefBlockPool — Represents a logical list of ByteRef backed by a ByteBlockPool. C BytesRefBuilder — A builder for BytesRef instances. C BytesRefComparator — Specialized BytesRef comparator that StringSorter has optimizations for. C BytesRefHash — BytesRefHash is a special purpose hash-map like data-structure optimized for BytesRef instances. I BytesRefIterator — A simple iterator interface for BytesRef iteration. C CharsRef — Represents char[], as a slice (offset + length) into an existing char[]. C CharsRefBuilder — A builder for CharsRef instances. I ClassLoaderUtils — Helper class used by ServiceLoader to investigate parent/child relationships of ClassLoaders. C ClasspathResourceLoader — Simple ResourceLoader that uses ClassLoader#getResourceAsStream(String) and Class#forName(String,boolean,ClassLoader) to open resources and classes, respectively. C CloseableThreadLocal — Java's builtin ThreadLocal has a serious flaw: it can take an arbitrarily long amount of time to dereference the things you had stored in it, even once the ThreadLocal instance itself is no longer referenced. C CollectionUtil — Methods for manipulating (sorting) and creating collections. C CommandLineUtil — Class containing some useful methods used by command line tools C Constants — Some useful constants. C Counter — Simple counter class C DenseLiveDocs — LiveDocs implementation optimized for dense deletions. C DocBaseBitSetIterator — A DocIdSetIterator like BitSetIterator but has a doc base in order to avoid storing previous 0s. C DocIdSetBuilder — A builder of DocIdSets. C FileDeleter — This class provides ability to track the reference counts of a set of index files and delete them when their counts decreased to 0. C FilterIterator — An Iterator implementation that filters elements with a boolean predicate. C FixedBitSet — BitSet of fixed length (numBits), backed by accessible (#getBits) long[], accessed with an int index, implementing Bits and DocIdSet. C FixedLengthBytesRefArray — Just like BytesRefArray except all values have the same length. I FloatToFloatFunction — Simple interface to map one float to another (useful in scaling scores). C FrequencyTrackingRingBuffer — A ring buffer that tracks the frequency of the integers that it contains. C GroupVIntUtil — This class contains utility methods and constants for group varint I IOBooleanSupplier — Boolean supplier that is allowed to throw an IOException. I IOConsumer — An IO operation with a single input that may throw an IOException. I IOFunction — A Function that may throw an IOException I IORunnable — A Runnable that may throw an IOException I IOSupplier — This is a result supplier that is allowed to throw an IOException. C IOUtils — Utilities for dealing with Closeables. A IgnoreRandomChains — Annotation to not test a class or constructor with TestRandomChains integration test. C InPlaceMergeSorter — Sorter implementation based on the merge-sort algorithm that merges in place (no extra memory will be allocated). C InfoStream — Debugging API for Lucene classes such as IndexWriter and SegmentInfos. C IntBlockPool — A pool for int blocks similar to ByteBlockPool C IntroSelector — Adaptive selection algorithm based on the introspective quick select algorithm. C IntroSorter — Sorter implementation based on a variant of the quicksort algorithm called introsort: when the recursion level exceeds the log of the length of the array to sort, it falls back to heapsort. C IntsRef — Represents int[], as a slice (offset + length) into an existing int[]. C IntsRefBuilder — A builder for IntsRef instances. C JavaLoggingInfoStream — InfoStream implementation that logs every message using Java Utils Logging (JUL) with the supplied log level. C LSBRadixSorter — A LSB Radix sorter for unsigned int values. I LiveDocs — Extension of Bits that provides efficient iteration over deleted documents. C LongBitSet — BitSet of fixed length (numBits), backed by accessible (#getBits) long[], accessed with a long index. C LongHeap — A min heap that stores longs; a primitive priority queue that like all priority queues maintains a partial ordering of its elements such that the least element can always be found in constant time. C LongValues — Abstraction over an array of longs. C LongsRef — Represents long[], as a slice (offset + length) into an existing long[]. C MSBRadixSorter — Radix sorter for variable-length strings. C MapOfSets — Helper class for keeping Lists of Objects associated with keys. C MathUtil — Math static utility methods. C MergedIterator — Provides a merged sorted view from several sorted iterators. C ModuleResourceLoader — Simple ResourceLoader that uses Module#getResourceAsStream(String) and Class#forName(Module,String) to open resources and classes, respectively. C NamedSPILoader — Helper class for loading named SPIs from classpath (e.g. C NamedThreadFactory — A default ThreadFactory implementation that accepts the name prefix of the created threads as a constructor argument. C NotDocIdSet — This DocIdSet encodes the negation of another DocIdSet. C NumericUtils — Helper APIs to encode numeric values as sortable bytes and vice-versa. C OfflineSorter — On-disk sorting of byte arrays. C PagedBytes — Represents a logical byte[] as a series of pages. C PrintStreamInfoStream — InfoStream implementation over a PrintStream such as System.out. C PriorityQueue — A priority queue maintains a partial ordering of its elements such that the least element can always be found in constant time. C QueryBuilder — Creates queries from the Analyzer chain. C RadixSelector — Radix selector. C RamUsageEstimator — Estimates the size (memory representation) of Java objects. C RecyclingByteBlockAllocator — A ByteBlockPool.Allocator implementation that recycles unused byte blocks in a buffer and reuses them in subsequent calls to #getByteBlock(). C RecyclingIntBlockAllocator — A Allocator implementation that recycles unused int blocks in a buffer and reuses them in subsequent calls to #getIntBlock(). C RefCount — Manages reference counting for a given object. I ResourceLoader — Abstraction for loading resources (streams, files, and classes). I ResourceLoaderAware — Interface for a component that needs to be initialized by an implementation of ResourceLoader. C RoaringDocIdSet — DocIdSet implementation inspired from http://roaringbitmap.org/ The space is divided into blocks of 2^16 bits and each block is encoded independently. C RollingBuffer — Acts like forever growing T[], but internally uses a circular buffer to reuse instances of T. C SameThreadExecutorService — An ExecutorService that executes tasks immediately in the calling thread during submit. C Selector — An implementation of a selection algorithm, ie. C SentinelIntSet — A native int hash-based set where one value is reserved to mean "EMPTY" internally. C SetOnce — A convenient class which offers a semi-immutable object wrapper implementation which allows one to set the value of an object exactly once, and retrieve it many times. C SloppyMath — Math functions that trade off accuracy for speed. C SmallFloat — Floating point numbers smaller than 32 bits. C Sorter — Base class for sorting algorithms implementations. C SparseFixedBitSet — A bit set that only stores longs that have at least one bit which is set. C SparseLiveDocs — LiveDocs implementation optimized for sparse deletions. C StableMSBRadixSorter — Stable radix sorter for variable-length strings. C StringHelper — Methods for manipulating strings. C StringSorter — A BytesRef sorter tries to use a efficient radix sorter if StringSorter#cmp is a BytesRefComparator, otherwise fallback to StringSorter#fallbackSorter A SuppressForbidden — Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field. C TernaryLongHeap — A ternary min heap that stores longs; a primitive priority queue that like all priority queues maintains a partial ordering of its elements such that the least element can always be found in constant time. C ThreadInterruptedException — Thrown by lucene on detecting that Thread.interrupt() had been called. C TimSorter — Sorter implementation based on the TimSort algorithm. C ToStringUtils — Helper methods to ease implementing Object#toString(). C UnicodeUtil — Class to encode java's UTF16 char[] into UTF8 byte[] without always allocating a new byte[] as String.getBytes(StandardCharsets.UTF_8) does. I Unwrappable — An object with this interface is a wrapper around another object (e.g., a filter with a delegate). C VectorUtil — Utilities for computations with numeric arrays, especially algebraic operations like vector dot products. C Version — Use by certain classes to match version compatibility across releases of Lucene. C VirtualMethod — A utility for keeping backwards compatibility on previously abstract methods (or similar replacements). C WeakIdentityMap — Implements a combination of java.util.WeakHashMap and java.util.IdentityHashMap.

org.apache.lucene.util.RoaringDocIdSet 1

C Builder — A builder of RoaringDocIdSets.

org.apache.lucene.util.RollingBuffer 1

I Resettable — Implement to reset an instance

org.apache.lucene.util.fst.BytesRefFSTEnum 1

C InputOutput — Holds a single input (BytesRef) + output pair.

org.apache.lucene.util.fst.FSTCompiler 1

C Builder — Fluent-style constructor for FST FSTCompiler.

org.apache.lucene.util.fst.IntsRefFSTEnum 1

C InputOutput — Holds a single input (IntsRef) + output pair.

org.apache.lucene.util.fst.PairOutputs 1

C Pair — Holds a single pair of two outputs.

org.apache.lucene.util.hnsw 25

C BlockingFloatHeap — A blocking bounded min heap that stores floats. I CloseableRandomVectorScorerSupplier — A supplier that creates UpdateableRandomVectorScorer from an ordinal. C ConcurrentHnswMerger — This merger merges graph in a concurrent manner, by using HnswConcurrentMergeBuilder C FilteredHnswGraphSearcher — Searches an HNSW graph to find nearest neighbors to a query vector. C FloatHeap — A bounded min heap that stores floats. I HasKnnVectorValues — Implementors can return the KnnVectorValues from which their scorers read. I HnswBuilder — Interface for builder building the OnHeapHnswGraph C HnswConcurrentMergeBuilder — A graph builder that manages multiple workers, it only supports adding the whole graph all at once. C HnswGraph — Hierarchical Navigable Small World graph. C HnswGraphBuilder — Builder for HNSW graph. I HnswGraphMerger — Abstraction of merging multiple graphs into one on-heap graph C HnswGraphSearcher — Searches an HNSW graph to find nearest neighbors to a query vector. C HnswUtil — Utilities for use in tests involving HNSW graphs C IncrementalHnswGraphMerger — This merges multiple graphs in a single thread in incremental fashion. C InitializedHnswGraphBuilder — This creates a graph builder that is initialized with the provided HnswGraph. I IntToIntFunction — Native int to int function C MergingHnswGraphBuilder — A graph builder that is used during segments' merging. C NeighborArray — NeighborArray encodes the neighbors of a node and their mutual scores in the HNSW graph as a pair of growable arrays. C NeighborQueue — NeighborQueue uses a TernaryLongHeap to store lists of arcs in an HNSW graph, represented as a neighbor node id with an associated score packed together as a sortable long, which is sorted primarily by score. C OnHeapHnswGraph — An HnswGraph where all nodes and connections are held in memory. C OrdinalTranslatedKnnCollector — Wraps a provided KnnCollector object, translating the provided vectorId ordinal to a documentId I RandomVectorScorer — A RandomVectorScorer for scoring random nodes in batches against an abstract query. I RandomVectorScorerSupplier — A supplier that creates RandomVectorScorer from an ordinal. C UpdateGraphsUtils — Utility class for updating a big graph with smaller graphs. I UpdateableRandomVectorScorer — Just like a RandomVectorScorer but allows the scoring ordinal to be changed.

Internal packages

org.apache.lucene.internal.hppc 26

C AbstractIterator — Simplifies the implementation of iterators a bit. C BitMixer — Bit mixing utilities. C BufferAllocationException — BufferAllocationException forked from HPPC. C CharCursor — Forked from HPPC, holding int index and char value. C CharHashSet — A hash set of chars, implemented using open addressing with linear probing for collision resolution. C CharObjectHashMap — A hash map of char to Object, implemented using open addressing with linear probing for collision resolution. C DoubleCursor — Forked from HPPC, holding int index and double value. C FloatArrayList — An array-backed list of float. C FloatCursor — Forked from HPPC, holding int index and float value. C IntArrayList — An array-backed list of int. C IntCursor — Forked from HPPC, holding int index and int value. C IntDoubleHashMap — A hash map of int to double, implemented using open addressing with linear probing for collision resolution. C IntFloatHashMap — A hash map of int to float, implemented using open addressing with linear probing for collision resolution. C IntHashSet — A hash set of ints, implemented using open addressing with linear probing for collision resolution. C IntIntHashMap — A hash map of int to int, implemented using open addressing with linear probing for collision resolution. C IntLongHashMap — A hash map of int to long, implemented using open addressing with linear probing for collision resolution. C IntObjectHashMap — A hash map of int to Object, implemented using open addressing with linear probing for collision resolution. C LongArrayList — An array-backed list of long. C LongCursor — Forked from HPPC, holding int index and long value. C LongFloatHashMap — A hash map of long to float, implemented using open addressing with linear probing for collision resolution. C LongHashSet — A hash set of longs, implemented using open addressing with linear probing for collision resolution. C LongIntHashMap — A hash map of long to int, implemented using open addressing with linear probing for collision resolution. C LongObjectHashMap — A hash map of long to Object, implemented using open addressing with linear probing for collision resolution. C MaxSizedFloatArrayList — An array-backed list of float with a maximum size limit. C MaxSizedIntArrayList — An array-backed list of int with a maximum size limit. C ObjectCursor — Forked from HPPC, holding int index and Object value.

org.apache.lucene.internal.tests.IndexPackageAccess 1

I FieldInfosBuilder — Public type exposing FieldInfo internal builders.