Uses of Package
org.apache.lucene.codecs
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.0 file format.
BlockTree terms dictionary.
Lucene 9.0 compressing format.
Lucene 9.1 file format.
Postings format that can delegate to different formats per-field.
Code to maintain and access indices.
Block KD-tree, implementing the generic spatial data structure described in this paper.
-
ClassDescriptionHolds all state required for
PostingsReaderBase
to produce aPostingsEnum
without re-seeking the terms dict.Encodes/decodes an inverted index segment.This class accumulates the (freq, norm) pairs that may produce competitive scores.A read-onlyDirectory
that consists of a view over a compound file.Encodes/decodes compound filesAbstract API that consumes numeric, binary and sorted docvalues.Encodes/decodes per-document values.Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.Encodes/decodesFieldInfos
Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.Abstract API that produces terms, doc, freq, prox, offset and payloads postings.Encodes/decodes per-document vector and any associated indexing structures required to support nearest-neighbor searchReads vectors from an index.Writes vectors to an index.Format for live/deleted documentsAbstract API that consumes normalization values.Encodes/decodes per-document score normalization values.Abstract API that produces field normalization valuesEncodes/decodes indexed points.Abstract API to visit point values.Abstract API to write pointsEncodes/decodes terms, postings, and proximity data.Class that plugs into term dictionaries, such asLucene90BlockTreeTermsWriter
, and handles writing postings.Expert: Controls the format of theSegmentInfo
(segment metadata file).Controls the format of stored fieldsCodec API for reading stored fields.Codec API for writing stored fields: For every document,StoredFieldsWriter.startDocument()
is called, informing the Codec that a new document has started.Controls the format of term vectorsCodec API for reading term vectors:Codec API for writing term vectors: For every document,TermVectorsWriter.startDocument(int)
is called, informing the Codec how many fields will be written. -
ClassDescriptionHolds all state required for
PostingsReaderBase
to produce aPostingsEnum
without re-seeking the terms dict.A read-onlyDirectory
that consists of a view over a compound file.Encodes/decodes compound filesAbstract API that consumes numeric, binary and sorted docvalues.Encodes/decodes per-document values.Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.Encodes/decodesFieldInfos
Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.Abstract API that produces terms, doc, freq, prox, offset and payloads postings.Format for live/deleted documentsAbstract API that consumes normalization values.Encodes/decodes per-document score normalization values.Abstract API that produces field normalization valuesEncodes/decodes indexed points.Abstract API to visit point values.Abstract API to write pointsEncodes/decodes terms, postings, and proximity data.The core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation ofPostingsEnum
andPostingsEnum
instances.Class that plugs into term dictionaries, such asLucene90BlockTreeTermsWriter
, and handles writing postings.Extension ofPostingsWriterBase
, adding a push API for writing each element of the postings.Expert: Controls the format of theSegmentInfo
(segment metadata file).Controls the format of stored fieldsCodec API for reading stored fields.Codec API for writing stored fields: For every document,StoredFieldsWriter.startDocument()
is called, informing the Codec that a new document has started.Controls the format of term vectors -
ClassDescriptionAbstract API that consumes terms, doc, freq, prox, offset and payloads postings.Abstract API that produces terms, doc, freq, prox, offset and payloads postings.Abstract API that produces field normalization valuesThe core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation of
PostingsEnum
andPostingsEnum
instances.Class that plugs into term dictionaries, such asLucene90BlockTreeTermsWriter
, and handles writing postings. -
ClassDescriptionControls the format of stored fieldsCodec API for reading stored fields.Codec API for writing stored fields: For every document,
StoredFieldsWriter.startDocument()
is called, informing the Codec that a new document has started.Controls the format of term vectorsCodec API for reading term vectors:Codec API for writing term vectors: For every document,TermVectorsWriter.startDocument(int)
is called, informing the Codec how many fields will be written. -
ClassDescriptionEncodes/decodes an inverted index segment.Encodes/decodes compound filesEncodes/decodes per-document values.Encodes/decodes
FieldInfos
Encodes/decodes per-document vector and any associated indexing structures required to support nearest-neighbor searchReads vectors from an index.Writes vectors to an index.Format for live/deleted documentsEncodes/decodes per-document score normalization values.Encodes/decodes indexed points.Encodes/decodes terms, postings, and proximity data.Expert: Controls the format of theSegmentInfo
(segment metadata file).Controls the format of stored fieldsControls the format of term vectors -
ClassDescriptionAbstract API that consumes numeric, binary and sorted docvalues.Encodes/decodes per-document values.Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.Abstract API that produces terms, doc, freq, prox, offset and payloads postings.Encodes/decodes per-document vector and any associated indexing structures required to support nearest-neighbor searchReads vectors from an index.Writes vectors to an index.Encodes/decodes terms, postings, and proximity data.
-
ClassDescriptionEncodes/decodes an inverted index segment.Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.Abstract API that produces terms, doc, freq, prox, offset and payloads postings.Reads vectors from an index.Abstract API that produces field normalization valuesAbstract API to visit point values.Codec API for reading stored fields.Codec API for reading term vectors:
-