Uses of Class
org.apache.lucene.index.CodecReader

Packages that use CodecReader

Package	Description
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.misc.index	Misc index tools and index support.

Uses of CodecReader in org.apache.lucene.index

Subclasses of CodecReader in org.apache.lucene.index

Modifier and Type	Class	Description
class	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.
final class	SegmentReader	IndexReader implementation over a single segment.
(package private) final class	SlowCompositeCodecReaderWrapper	A merged CodecReader view of multiple CodecReader.
(package private) static final class	SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader
final class	SortingCodecReader	An CodecReader which supports sorting documents by a given Sort.

Fields in org.apache.lucene.index declared as CodecReader

Modifier and Type	Field	Description
(package private) final CodecReader	MergePolicy.MergeReader.codecReader
private final CodecReader[]	SlowCompositeCodecReaderWrapper.codecReaders
private final CodecReader[]	SlowCompositeCodecReaderWrapper.SlowCompositeDocValuesProducerWrapper.codecReaders
private final CodecReader[]	SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper.codecReaders
private final CodecReader[]	SlowCompositeCodecReaderWrapper.SlowCompositeNormsProducer.codecReaders
private final CodecReader[]	SlowCompositeCodecReaderWrapper.SlowCompositePointsReaderWrapper.codecReaders
protected final CodecReader	FilterCodecReader.in	The underlying CodecReader instance.

Methods in org.apache.lucene.index that return CodecReader

Modifier and Type	Method	Description
(package private) static CodecReader	SoftDeletesRetentionMergePolicy.applyRetentionQuery(String softDeleteField, Query retentionQuery, CodecReader reader)
CodecReader	FilterCodecReader.getDelegate()	Returns the wrapped CodecReader.
private CodecReader	ReadersAndUpdates.getLatestReader()
static CodecReader	FilterCodecReader.unwrap(CodecReader reader)	Get the wrapped instance by reader as long as this reader is an instance of FilterCodecReader.
static CodecReader	SlowCodecReaderWrapper.wrap(LeafReader reader)	Returns a CodecReader view of reader.
(package private) static CodecReader	SlowCompositeCodecReaderWrapper.wrap(List<CodecReader> readers)
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sorter.DocMap docMap, Sort sort)	Expert: same as SortingCodecReader.wrap(org.apache.lucene.index.CodecReader, Sort) but operates directly on a Sorter.DocMap.
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sort sort)	Return a sorted view of reader according to the order defined by sort .
CodecReader	MergePolicy.OneMerge.wrapForMerge(CodecReader reader)	Wrap a reader prior to merging in order to add/remove fields or documents.

Methods in org.apache.lucene.index with parameters of type CodecReader

Modifier and Type	Method	Description
long	IndexWriter.addIndexes(CodecReader... readers)	Merges the provided indexes into this index.
(package private) static CodecReader	SoftDeletesRetentionMergePolicy.applyRetentionQuery(String softDeleteField, Query retentionQuery, CodecReader reader)
private boolean	IndexWriter.assertSoftDeletesCount(CodecReader reader, int expectedCount)
private static void	CheckIndex.checkByteVectorValues(ByteVectorValues values, FieldInfo fieldInfo, CheckIndex.Status.VectorValuesStatus status, CodecReader codecReader)
private static void	CheckIndex.checkFloatVectorValues(FloatVectorValues values, FieldInfo fieldInfo, CheckIndex.Status.VectorValuesStatus status, CodecReader codecReader)
private void	IndexWriter.countSoftDeletes(CodecReader reader, Bits wrappedLiveDocs, Bits hardLiveDocs, Counter softDeleteCounter, Counter hardDeleteCounter)
MergePolicy.MergeSpecification	FilterMergePolicy.findMerges(CodecReader... readers)
MergePolicy.MergeSpecification	MergePolicy.findMerges(CodecReader... readers)	Define the set of merge operations to perform on provided codec readers in IndexWriter.addIndexes(CodecReader...).
MergePolicy.MergeSpecification	NoMergePolicy.findMerges(CodecReader... readers)
private static Scorer	SoftDeletesRetentionMergePolicy.getScorer(Query query, CodecReader reader)
(package private) final boolean	PendingDeletes.needsRefresh(CodecReader reader)	Returns true if the given reader needs to be refreshed in order to see the latest deletes
(package private) void	PendingDeletes.onNewReader(CodecReader reader, SegmentCommitInfo info)	Called once a new reader is opened for this segment ie.
(package private) void	PendingSoftDeletes.onNewReader(CodecReader reader, SegmentCommitInfo info)
Sorter.DocMap	MergePolicy.OneMerge.reorder(CodecReader reader, Directory dir)	Extend this method if you wish to renumber doc IDs.
static CheckIndex.Status.DocValuesStatus	CheckIndex.testDocValues(CodecReader reader, PrintStream infoStream, boolean failFast)	Test docvalues.
static CheckIndex.Status.FieldInfoStatus	CheckIndex.testFieldInfos(CodecReader reader, PrintStream infoStream, boolean failFast)	Test field infos.
static CheckIndex.Status.FieldNormStatus	CheckIndex.testFieldNorms(CodecReader reader, PrintStream infoStream, boolean failFast)	Test field norms.
static CheckIndex.Status.LiveDocStatus	CheckIndex.testLiveDocs(CodecReader reader, PrintStream infoStream, boolean failFast)	Test live docs.
static CheckIndex.Status.PointsStatus	CheckIndex.testPoints(CodecReader reader, PrintStream infoStream, boolean failFast)	Test the points index.
static CheckIndex.Status.TermIndexStatus	CheckIndex.testPostings(CodecReader reader, PrintStream infoStream)	Test the term index.
static CheckIndex.Status.TermIndexStatus	CheckIndex.testPostings(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)	Test the term index.
static CheckIndex.Status.IndexSortStatus	CheckIndex.testSort(CodecReader reader, Sort sort, PrintStream infoStream, boolean failFast)	Tests index sort order.
static CheckIndex.Status.StoredFieldStatus	CheckIndex.testStoredFields(CodecReader reader, PrintStream infoStream, boolean failFast)	Test stored fields.
static CheckIndex.Status.TermVectorStatus	CheckIndex.testTermVectors(CodecReader reader, PrintStream infoStream)	Test term vectors.
static CheckIndex.Status.TermVectorStatus	CheckIndex.testTermVectors(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)	Test term vectors.
static CheckIndex.Status.VectorValuesStatus	CheckIndex.testVectors(CodecReader reader, PrintStream infoStream, boolean failFast)	Test the vectors index.
static CodecReader	FilterCodecReader.unwrap(CodecReader reader)	Get the wrapped instance by reader as long as this reader is an instance of FilterCodecReader.
private void	IndexWriter.validateMergeReader(CodecReader leaf)
(package private) boolean	PendingDeletes.verifyDocCounts(CodecReader reader)
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sorter.DocMap docMap, Sort sort)	Expert: same as SortingCodecReader.wrap(org.apache.lucene.index.CodecReader, Sort) but operates directly on a Sorter.DocMap.
static CodecReader	SortingCodecReader.wrap(CodecReader reader, Sort sort)	Return a sorted view of reader according to the order defined by sort .
CodecReader	MergePolicy.OneMerge.wrapForMerge(CodecReader reader)	Wrap a reader prior to merging in order to add/remove fields or documents.
(package private) static FilterCodecReader	FilterCodecReader.wrapLiveDocs(CodecReader reader, Bits liveDocs, int numDocs)	Returns a filtered codec reader with the given live docs and numDocs.

Method parameters in org.apache.lucene.index with type arguments of type CodecReader

Modifier and Type	Method	Description
private MergeState.DocMap[]	MergeState.buildDeletionDocMaps(List<CodecReader> readers)
private MergeState.DocMap[]	MergeState.buildDocMaps(List<CodecReader> readers, Sort indexSort)
private void	PendingSoftDeletes.ensureInitialized(IOSupplier<CodecReader> readerIOSupplier)
(package private) boolean	PendingDeletes.isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)	Returns true iff the segment represented by this PendingDeletes is fully deleted
(package private) boolean	PendingSoftDeletes.isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)
boolean	FilterMergePolicy.keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)
boolean	MergePolicy.keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)	Returns true if the segment represented by the given CodecReader should be keep even if it's fully deleted.
boolean	NoMergePolicy.keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)
boolean	SoftDeletesRetentionMergePolicy.keepFullyDeletedSegment(IOSupplier<CodecReader> readerIOSupplier)
int	FilterMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
int	MergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)	Returns the number of deletes that a merge would claim on the given segment.
int	NoMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
(package private) int	PendingDeletes.numDeletesToMerge(MergePolicy policy, IOSupplier<CodecReader> readerIOSupplier)
(package private) int	PendingSoftDeletes.numDeletesToMerge(MergePolicy policy, IOSupplier<CodecReader> readerIOSupplier)
int	SoftDeletesRetentionMergePolicy.numDeletesToMerge(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)
(package private) static MergeState.DocMap[]	MultiSorter.sort(Sort sort, List<CodecReader> readers)	Does a merge sort of the leaves of the incoming reader, returning MergeState.DocMap to map each leaf's documents into the merged segment.
private static void	MergeState.verifyIndexSort(List<CodecReader> readers, SegmentInfo segmentInfo)
(package private) static CodecReader	SlowCompositeCodecReaderWrapper.wrap(List<CodecReader> readers)

Constructors in org.apache.lucene.index with parameters of type CodecReader

Modifier	Constructor	Description
	FilterCodecReader(CodecReader in)	Creates a new FilterCodecReader.
(package private)	MergeReader(CodecReader reader, Bits hardLiveDocs)
	OneMerge(CodecReader... codecReaders)	Create a OneMerge directly from CodecReaders.
(package private)	SlowCompositeDocValuesProducerWrapper(CodecReader[] codecReaders, int[] docStarts)
(package private)	SlowCompositeKnnVectorsReaderWrapper(CodecReader[] codecReaders, int[] docStarts)
(package private)	SlowCompositeNormsProducer(CodecReader[] codecReaders)
(package private)	SlowCompositePointsReaderWrapper(CodecReader[] codecReaders, int[] docStarts)
private	SoftDeletesFilterCodecReader(CodecReader reader, FixedBitSet bits, int numDocs)
private	SortingCodecReader(CodecReader in, Sorter.DocMap docMap, LeafMetaData metaData)

Constructor parameters in org.apache.lucene.index with type arguments of type CodecReader

Modifier	Constructor	Description
(package private)	MergeState(List<CodecReader> readers, SegmentInfo segmentInfo, InfoStream infoStream, Executor intraMergeTaskExecutor)	Sole constructor.
(package private)	SegmentMerger(List<CodecReader> readers, SegmentInfo segmentInfo, InfoStream infoStream, Directory dir, FieldInfos.FieldNumbers fieldNumbers, IOContext context, Executor intraMergeTaskExecutor)
private	SlowCompositeCodecReaderWrapper(List<CodecReader> codecReaders)

Uses of CodecReader in org.apache.lucene.misc.index

Subclasses of CodecReader in org.apache.lucene.misc.index

Modifier and Type	Class	Description
private static class	IndexRearranger.DocSelectorFilteredCodecReader
private static final class	MultiPassIndexSplitter.FakeDeleteLeafIndexReader
private static class	PKIndexSplitter.DocumentFilteredLeafIndexReader

Methods in org.apache.lucene.misc.index that return CodecReader

Modifier and Type	Method	Description
CodecReader	BPIndexReorderer.reorder(CodecReader reader, Directory tempDir)	Reorder the given CodecReader into a reader that tries to minimize the log gap between consecutive documents in postings, which usually helps improve space efficiency and query evaluation efficiency.

Methods in org.apache.lucene.misc.index with parameters of type CodecReader

Modifier and Type	Method	Description
Sorter.DocMap	BPIndexReorderer.computeDocMap(CodecReader reader, Directory tempDir)	Expert: Compute the Sorter.DocMap that holds the new doc ID numbering.
private int[]	BPIndexReorderer.computePermutation(CodecReader reader, Set<String> fields, Directory dir)	Compute a permutation of the doc ID space that reduces log gaps between consecutive postings.
MergePolicy.MergeSpecification	BPReorderingMergePolicy.findMerges(CodecReader... readers)
BitSet	BinaryDocValueSelector.getFilteredLiveDocs(CodecReader reader)
BitSet	IndexRearranger.DocumentSelector.getFilteredLiveDocs(CodecReader reader)
CodecReader	BPIndexReorderer.reorder(CodecReader reader, Directory tempDir)	Reorder the given CodecReader into a reader that tries to minimize the log gap between consecutive documents in postings, which usually helps improve space efficiency and query evaluation efficiency.
private int	BPIndexReorderer.writePostings(CodecReader reader, Set<String> fields, Directory tempDir, DataOutput postingsOut)

Constructors in org.apache.lucene.misc.index with parameters of type CodecReader

Modifier	Constructor	Description
	DocSelectorFilteredCodecReader(CodecReader in, IndexRearranger.DocumentSelector selector)
	FakeDeleteLeafIndexReader(CodecReader reader)