Uses of Class
org.apache.lucene.index.IndexReader
Packages that use IndexReader
Package
Description
Code to maintain and access indices.
Code to search indices.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
-
Uses of IndexReader in org.apache.lucene.index
Classes in org.apache.lucene.index with type parameters of type IndexReaderModifier and TypeClassDescriptionclassBaseCompositeReader<R extends IndexReader>Base class for implementingCompositeReaders based on an array of sub-readers.Subclasses of IndexReader in org.apache.lucene.indexModifier and TypeClassDescriptionclassBaseCompositeReader<R extends IndexReader>Base class for implementingCompositeReaders based on an array of sub-readers.classLeafReader implemented by codec APIs.classInstances 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.classDirectoryReader is an implementation ofCompositeReaderthat can read indexes in aDirectory.classTheExitableDirectoryReaderwraps a real indexDirectoryReaderand allows for aQueryTimeoutimplementation object to be checked periodically to see if the thread should exit or not.static classWrapper class for another FilterAtomicReader.classAFilterCodecReadercontains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.classA FilterDirectoryReader wraps another DirectoryReader, allowing implementations to transform or extend it.classAFilterLeafReadercontains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.classLeafReaderis an abstract class, providing an interface for accessing an index.classACompositeReaderwhich reads multiple indexes, appending their content.classAnCompositeReaderwhich reads multiple, parallel indexes.classAnLeafReaderwhich reads multiple, parallel indexes.final classIndexReader implementation over a single segment.final classThis reader filters out documents that have a doc values value in the given field and treat these documents as soft deleted.final classAnCodecReaderwhich supports sorting documents by a givenSort.final classDefault implementation ofDirectoryReader.Methods in org.apache.lucene.index that return IndexReaderModifier and TypeMethodDescriptionabstract IndexReaderIndexReaderContext.reader()Returns theIndexReader, this context represents.Methods in org.apache.lucene.index that return types with arguments of type IndexReaderModifier and TypeMethodDescriptionprotected abstract List<? extends IndexReader> CompositeReader.getSequentialSubReaders()Expert: returns the sequential sub readers that this reader is logically composed of.Methods in org.apache.lucene.index with parameters of type IndexReaderModifier and TypeMethodDescriptionstatic BinaryDocValuesMultiDocValues.getBinaryValues(IndexReader r, String field) Returns a BinaryDocValues for a reader's docvalues (potentially merging on-the-fly)static intPointValues.getDocCount(IndexReader reader, String field) Return the cumulated number of docs that have points across all leaves of the givenIndexReader.static Collection<String> FieldInfos.getIndexedFields(IndexReader reader) Returns a set of names of fields that have a terms index.static BitsMultiBits.getLiveDocs(IndexReader reader) Returns a singleBitsinstance for this reader, merging live Documents on the fly.static byte[]PointValues.getMaxPackedValue(IndexReader reader, String field) Return the maximum packed values across all leaves of the givenIndexReader.static FieldInfosFieldInfos.getMergedFieldInfos(IndexReader reader) Call this to get the (merged) FieldInfos for a composite reader.static byte[]PointValues.getMinPackedValue(IndexReader reader, String field) Return the minimum packed values across all leaves of the givenIndexReader.static NumericDocValuesMultiDocValues.getNormValues(IndexReader r, String field) Returns a NumericDocValues for a reader's norms (potentially merging on-the-fly).static NumericDocValuesMultiDocValues.getNumericValues(IndexReader r, String field) Returns a NumericDocValues for a reader's docvalues (potentially merging on-the-fly)static SortedNumericDocValuesMultiDocValues.getSortedNumericValues(IndexReader r, String field) Returns a SortedNumericDocValues for a reader's docvalues (potentially merging on-the-fly)static SortedSetDocValuesMultiDocValues.getSortedSetValues(IndexReader r, String field) Returns a SortedSetDocValues for a reader's docvalues (potentially doing extremely slow things).static SortedDocValuesMultiDocValues.getSortedValues(IndexReader r, String field) Returns a SortedDocValues for a reader's docvalues (potentially doing extremely slow things).static PostingsEnumMultiTerms.getTermPostingsEnum(IndexReader r, String field, BytesRef term) ReturnsPostingsEnumfor the specified field and term.static PostingsEnumMultiTerms.getTermPostingsEnum(IndexReader r, String field, BytesRef term, int flags) ReturnsPostingsEnumfor the specified field and term, with control over whether freqs, positions, offsets or payloads are required.static TermsMultiTerms.getTerms(IndexReader r, String field) This method may return null if the field does not exist or if it has no terms.final voidIndexReader.registerParentReader(IndexReader reader) Expert: This method is called byIndexReaders which wrap other readers (e.g.static longPointValues.size(IndexReader reader, String field) Return the cumulated number of points across all leaves of the givenIndexReader.longIndexWriter.tryDeleteDocument(IndexReader readerIn, int docID) Expert: attempts to delete by document ID, as long as the provided reader is a near-real-time reader (fromDirectoryReader.open(IndexWriter)).longIndexWriter.tryUpdateDocValue(IndexReader readerIn, int docID, Field... fields) Expert: attempts to update doc values by document ID, as long as the provided reader is a near-real-time reader (fromDirectoryReader.open(IndexWriter)).Constructors in org.apache.lucene.index with parameters of type IndexReaderModifierConstructorDescriptionprotectedBaseCompositeReader(R[] subReaders, Comparator<R> subReadersSorter) Constructs aBaseCompositeReaderon the given subReaders.MultiReader(IndexReader... subReaders) Construct a MultiReader aggregating the named set of (sub)readers.MultiReader(IndexReader[] subReaders, boolean closeSubReaders) Construct a MultiReader aggregating the named set of (sub)readers.MultiReader(IndexReader[] subReaders, Comparator<IndexReader> subReadersSorter, boolean closeSubReaders) Construct a MultiReader aggregating the named set of (sub)readers.Constructor parameters in org.apache.lucene.index with type arguments of type IndexReaderModifierConstructorDescriptionMultiReader(IndexReader[] subReaders, Comparator<IndexReader> subReadersSorter, boolean closeSubReaders) Construct a MultiReader aggregating the named set of (sub)readers. -
Uses of IndexReader in org.apache.lucene.search
Methods in org.apache.lucene.search that return IndexReaderModifier and TypeMethodDescriptionIndexSearcher.getIndexReader()Return theIndexReaderthis searches.Methods in org.apache.lucene.search with parameters of type IndexReaderModifier and TypeMethodDescriptionstatic IndexSearcherSearcherManager.getSearcher(SearcherFactory searcherFactory, IndexReader reader, IndexReader previousReader) Expert: creates a searcher from the providedIndexReaderusing the providedSearcherFactory.SearcherFactory.newSearcher(IndexReader reader, IndexReader previousReader) Returns a new IndexSearcher over the given reader.Constructors in org.apache.lucene.search with parameters of type IndexReaderModifierConstructorDescriptionCreates a searcher searching the provided index.IndexSearcher(IndexReader r, Executor executor) Runs searches for each segment separately, using the provided Executor. -
Uses of IndexReader in org.apache.lucene.util.hnsw
Methods in org.apache.lucene.util.hnsw with parameters of type IndexReaderModifier and TypeMethodDescriptionstatic booleanHnswUtil.graphIsRooted(IndexReader reader, String vectorField) In graph theory, "connected components" are really defined only for undirected (ie bidirectional) graphs.