# Uses of Package
org.apache.lucene.codecs

Packages that use org.apache.lucene.codecs
Package | Description
--- | ---
org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.lucene3x | Codec to support Lucene 3.x indexes (readonly)
org.apache.lucene.codecs.lucene40 | Lucene 4.0 file format.
org.apache.lucene.codecs.lucene41 | Lucene 4.1 file format.
org.apache.lucene.codecs.lucene42 | Lucene 4.2 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.

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 `DocsEnum` without re-seeking the terms dict.
BlockTreeTermsReader.Stats BlockTree statistics for a single field returned by `BlockTreeTermsReader.FieldReader.computeStats()`.
Codec Encodes/decodes an inverted index segment.
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary and sorted docvalues.
FieldInfosFormat Encodes/decodes `FieldInfos`
FieldInfosReader Codec API for reading `FieldInfos`.
FieldInfosWriter Codec API for writing `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.
PostingsConsumer Abstract API that consumes postings for an individual term.
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 `DocsEnum` and `DocsAndPositionsEnum` instances.
PostingsWriterBase Extension of `PostingsConsumer` to support pluggable term dictionaries.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
SegmentInfoReader Specifies an API for classes that can read `SegmentInfo` information.
SegmentInfoWriter Specifies an API for classes that can write out `SegmentInfo` data.
StoredFieldsFormat Controls the format of stored fields
StoredFieldsReader Codec API for reading stored fields.
StoredFieldsWriter Codec API for writing stored fields:
TermsConsumer Abstract API that consumes terms for an individual field.
TermStats Holder for per-term statistics.
TermVectorsFormat Controls the format of term vectors
TermVectorsReader Codec API for reading term vectors:
TermVectorsWriter Codec API for writing term vectors:

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:
TermVectorsFormat Controls the format of term vectors
TermVectorsReader Codec API for reading term vectors:
TermVectorsWriter Codec API for writing term vectors:

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene3x
Class and Description
Codec Encodes/decodes an inverted index segment.
DocValuesFormat Encodes/decodes per-document values.
FieldInfosFormat Encodes/decodes `FieldInfos`
LiveDocsFormat Format for live/deleted documents
NormsFormat Encodes/decodes per-document score normalization values.
PostingsFormat Encodes/decodes terms, postings, and proximity data.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
SegmentInfoReader Specifies an API for classes that can read `SegmentInfo` information.
SegmentInfoWriter Specifies an API for classes that can write out `SegmentInfo` data.
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.lucene40
Class and Description
BlockTermState Holds all state required for `PostingsReaderBase` to produce a `DocsEnum` without re-seeking the terms dict.
Codec Encodes/decodes an inverted index segment.
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary and sorted docvalues.
FieldInfosFormat Encodes/decodes `FieldInfos`
FieldInfosReader Codec API for reading `FieldInfos`.
FieldInfosWriter Codec API for writing `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
MultiLevelSkipListReader This abstract class reads skip lists with multiple levels.
NormsFormat Encodes/decodes per-document score normalization values.
PostingsBaseFormat Provides a `PostingsReaderBase` and `PostingsWriterBase`.
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 `DocsEnum` and `DocsAndPositionsEnum` instances.
PostingsWriterBase Extension of `PostingsConsumer` to support pluggable term dictionaries.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
SegmentInfoReader Specifies an API for classes that can read `SegmentInfo` information.
SegmentInfoWriter Specifies an API for classes that can write out `SegmentInfo` data.
StoredFieldsFormat Controls the format of stored fields
StoredFieldsReader Codec API for reading stored fields.
StoredFieldsWriter Codec API for writing stored fields:
TermVectorsFormat Controls the format of term vectors
TermVectorsReader Codec API for reading term vectors:
TermVectorsWriter Codec API for writing term vectors:

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene41
Class and Description
BlockTermState Holds all state required for `PostingsReaderBase` to produce a `DocsEnum` without re-seeking the terms dict.
Codec Encodes/decodes an inverted index segment.
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.
PostingsBaseFormat Provides a `PostingsReaderBase` and `PostingsWriterBase`.
PostingsConsumer Abstract API that consumes postings for an individual term.
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 `DocsEnum` and `DocsAndPositionsEnum` instances.
PostingsWriterBase Extension of `PostingsConsumer` to support pluggable term dictionaries.
SegmentInfoFormat Expert: Controls the format of the `SegmentInfo` (segment metadata file).
StoredFieldsFormat Controls the format of stored fields
TermStats Holder for per-term statistics.
TermVectorsFormat Controls the format of term vectors

Classes in org.apache.lucene.codecs used by org.apache.lucene.codecs.lucene42
Class and Description
Codec Encodes/decodes an inverted index segment.
DocValuesConsumer Abstract API that consumes numeric, binary and sorted docvalues.
DocValuesFormat Encodes/decodes per-document values.
DocValuesProducer Abstract API that produces numeric, binary and sorted docvalues.
FieldInfosFormat Encodes/decodes `FieldInfos`
FieldInfosReader Codec API for reading `FieldInfos`.
FieldInfosWriter Codec API for writing `FieldInfos`.
LiveDocsFormat Format for live/deleted documents
NormsFormat Encodes/decodes per-document score normalization values.
PostingsFormat Encodes/decodes terms, postings, and proximity data.
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 and sorted 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
BlockTreeTermsReader.Stats BlockTree statistics for a single field returned by `BlockTreeTermsReader.FieldReader.computeStats()`.
Codec Encodes/decodes an inverted index segment.
StoredFieldsReader Codec API for reading stored fields.
TermVectorsReader Codec API for reading term vectors: