# Uses of Package
org.apache.lucene.codecs

Packages that use org.apache.lucene.codecs
org.apache.lucene.codecs: Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.blocktree: BlockTree terms dictionary.
org.apache.lucene.codecs.compressing: StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.lucene50: Components from the Lucene 5.0 index format See `org.apache.lucene.codecs.lucene80` for an overview of the index format.
org.apache.lucene.codecs.lucene60: Components from the Lucene 6.0 index format.
org.apache.lucene.codecs.lucene70: Components from the Lucene 7.0 index format.
org.apache.lucene.codecs.lucene80: Components from the Lucene 8.0 index format See `org.apache.lucene.codecs.lucene84` for an overview of the index format.
org.apache.lucene.codecs.lucene84: Lucene 8.4 file format.
org.apache.lucene.codecs.perfield: Postings format that can delegate to different formats per-field.
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.util.bkd: Block KD-tree, implementing the generic spatial data structure described in this paper.

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs
Class and Description
BlockTermState Holds all state required for `PostingsReaderBase` to produce a `PostingsEnum` without re-seeking the terms dict.
Codec Encodes/decodes an inverted index segment.
CompetitiveImpactAccumulator This class accumulates the (freq, norm) pairs that may produce competitive scores.
CompoundFormat Encodes/decodes compound files
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.
FieldInfosFormat Encodes/decodes `FieldInfos`
FieldsConsumer Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.
FieldsProducer Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
LiveDocsFormat Format for live/deleted documents
NormsConsumer Abstract API that consumes normalization values.
NormsFormat Encodes/decodes per-document score normalization values.
NormsProducer Abstract API that produces field normalization values
PointsFormat Encodes/decodes indexed points.
PointsReader Abstract API to visit point values.
PointsWriter Abstract API to write points
PostingsFormat Encodes/decodes terms, postings, and proximity data.
PostingsWriterBase Class that plugs into term dictionaries, such as `BlockTreeTermsWriter`, and handles writing postings.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
StoredFieldsFormat Controls the format of stored fields
StoredFieldsReader Codec API for reading stored fields.
StoredFieldsWriter Codec API for writing stored fields: For every document, `StoredFieldsWriter.startDocument()` is called, informing the Codec that a new document has started.
TermVectorsFormat Controls the format of term vectors
TermVectorsReader Codec API for reading term vectors:
TermVectorsWriter Codec API for writing term vectors: For every document, `TermVectorsWriter.startDocument(int)` is called, informing the Codec how many fields will be written.

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.blocktree
Class and Description
FieldsConsumer Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.
FieldsProducer Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
NormsProducer Abstract API that produces field normalization values
PostingsReaderBase The core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation of `PostingsEnum` and `PostingsEnum` instances.
PostingsWriterBase Class that plugs into term dictionaries, such as `BlockTreeTermsWriter`, and handles writing postings.

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.compressing
Class and Description
StoredFieldsFormat Controls the format of stored fields
StoredFieldsReader Codec API for reading stored fields.
StoredFieldsWriter Codec API for writing stored fields: For every document, `StoredFieldsWriter.startDocument()` is called, informing the Codec that a new document has started.
TermVectorsFormat Controls the format of term vectors
TermVectorsReader Codec API for reading term vectors:
TermVectorsWriter Codec API for writing term vectors: For every document, `TermVectorsWriter.startDocument(int)` is called, informing the Codec how many fields will be written.

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene50
Class and Description
CompoundFormat Encodes/decodes compound files
FieldInfosFormat Encodes/decodes `FieldInfos`
LiveDocsFormat Format for live/deleted documents
StoredFieldsFormat Controls the format of stored fields
StoredFieldsReader Codec API for reading stored fields.
StoredFieldsWriter Codec API for writing stored fields: For every document, `StoredFieldsWriter.startDocument()` is called, informing the Codec that a new document has started.
TermVectorsFormat Controls the format of term vectors

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene60
Class and Description
FieldInfosFormat Encodes/decodes `FieldInfos`
PointsFormat Encodes/decodes indexed points.
PointsReader Abstract API to visit point values.
PointsWriter Abstract API to write points

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene70
Class and Description
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene80
Class and Description
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.
NormsConsumer Abstract API that consumes normalization values.
NormsFormat Encodes/decodes per-document score normalization values.
NormsProducer Abstract API that produces field normalization values

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene84
Class and Description
BlockTermState Holds all state required for `PostingsReaderBase` to produce a `PostingsEnum` without re-seeking the terms dict.
Codec Encodes/decodes an inverted index segment.
CompoundFormat Encodes/decodes compound files
DocValuesFormat Encodes/decodes per-document values.
FieldInfosFormat Encodes/decodes `FieldInfos`
FieldsConsumer Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.
FieldsProducer Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
LiveDocsFormat Format for live/deleted documents
NormsFormat Encodes/decodes per-document score normalization values.
PointsFormat Encodes/decodes indexed points.
PostingsFormat Encodes/decodes terms, postings, and proximity data.
PostingsReaderBase The core terms dictionaries (BlockTermsReader, BlockTreeTermsReader) interact with a single instance of this class to manage creation of `PostingsEnum` and `PostingsEnum` instances.
PostingsWriterBase Class that plugs into term dictionaries, such as `BlockTreeTermsWriter`, and handles writing postings.
PushPostingsWriterBase Extension of `PostingsWriterBase`, adding a push API for writing each element of the postings.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
StoredFieldsFormat Controls the format of stored fields
TermVectorsFormat Controls the format of term vectors

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.perfield
Class and Description
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.
FieldsConsumer Abstract API that consumes terms, doc, freq, prox, offset and payloads postings.
FieldsProducer Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
PostingsFormat Encodes/decodes terms, postings, and proximity data.

Classes in org.apache.lucene.codecs used by org.apache.lucene.index
Class and Description
Codec Encodes/decodes an inverted index segment.
DocValuesProducer Abstract API that produces numeric, binary, sorted, sortedset, and sortednumeric docvalues.
FieldsProducer Abstract API that produces terms, doc, freq, prox, offset and payloads postings.
NormsProducer Abstract API that produces field normalization values
PointsReader Abstract API to visit point values.
StoredFieldsReader Codec API for reading stored fields.
TermVectorsReader Codec API for reading term vectors:

Classes in org.apache.lucene.codecs used by org.apache.lucene.util.bkd
Class and Description
MutablePointValues `PointValues` whose order of points can be changed.