## Uses of Class
org.apache.lucene.index.IndexReader

Packages that use IndexReader
org.apache.lucene.analysis.query: Automatically filter high-frequency stopwords.
org.apache.lucene.benchmark.byTask: Benchmarking Lucene By Tasks.
org.apache.lucene.benchmark.byTask.tasks: Extendable benchmark tasks.
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.misc
org.apache.lucene.queryParser.surround.query: This package contains SrndQuery and its subclasses.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.function: Programmatic control over documents scores.
org.apache.lucene.search.grouping: This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.
org.apache.lucene.search.highlight: The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.
org.apache.lucene.search.join: This module supports index-time joins while searching, where joined documents are indexed as a single document block using `IndexWriter.addDocuments(java.util.Collection<org.apache.lucene.document.Document>)`.
org.apache.lucene.search.payloads: The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.regex: Regular expression Query.
org.apache.lucene.search.similar: Document similarity query generators.
org.apache.lucene.search.spans: The calculus of spans.
org.apache.lucene.search.spell: Suggest alternate spellings for words.
org.apache.lucene.search.vectorhighlight: This is an another highlighter implementation.
org.apache.lucene.spatial.geohash: Support for Geohash encoding, decoding, and filtering.
org.apache.lucene.spatial.tier: Support for filtering based upon geographic location.
org.apache.lucene.store.instantiated: InstantiatedIndex, alternative RAM store for small corpora.
org.apache.lucene.util: Some utility classes.

Uses of IndexReader in org.apache.lucene.analysis.query

Methods in org.apache.lucene.analysis.query with parameters of type IndexReader
`int` `QueryAutoStopWordAnalyzer.addStopWords(IndexReader reader)` Automatically adds stop words for all fields with terms exceeding the defaultMaxDocFreqPercent
`int` `QueryAutoStopWordAnalyzer.addStopWords(IndexReader reader, float maxPercentDocs)` Automatically adds stop words for all fields with terms exceeding the maxDocFreqPercent
`int` `QueryAutoStopWordAnalyzer.addStopWords(IndexReader reader, int maxDocFreq)` Automatically adds stop words for all fields with terms exceeding the maxDocFreqPercent
`int` `QueryAutoStopWordAnalyzer.addStopWords(IndexReader reader, String fieldName, float maxPercentDocs)` Automatically adds stop words for the given field with terms exceeding the maxPercentDocs
`int` `QueryAutoStopWordAnalyzer.addStopWords(IndexReader reader, String fieldName, int maxDocFreq)` Automatically adds stop words for the given field with terms exceeding the maxPercentDocs

Uses of IndexReader in org.apache.lucene.benchmark.byTask

Methods in org.apache.lucene.benchmark.byTask that return IndexReader
`IndexReader` `PerfRunData.getIndexReader()`

Methods in org.apache.lucene.benchmark.byTask with parameters of type IndexReader
`void` `PerfRunData.setIndexReader(IndexReader indexReader)`

Uses of IndexReader in org.apache.lucene.benchmark.byTask.tasks

Methods in org.apache.lucene.benchmark.byTask.tasks with parameters of type IndexReader
`abstract int` `BenchmarkHighlighter.doHighlight(IndexReader reader, int doc, String field, Document document, Analyzer analyzer, String text)`
`protected Document` `SearchTravRetLoadFieldSelectorTask.retrieveDoc(IndexReader ir, int id)`
`protected Document` `ReadTask.retrieveDoc(IndexReader ir, int id)`

Uses of IndexReader in org.apache.lucene.index

Subclasses of IndexReader in org.apache.lucene.index
`class` `FilterIndexReader` A `FilterIndexReader` contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
`static class` `MultiPassIndexSplitter.FakeDeleteIndexReader` This class pretends that it can write deletions to the underlying index.
`class` `MultiReader` An IndexReader which reads multiple indexes, appending their content.
`class` `ParallelReader` An IndexReader which reads multiple, parallel indexes.
`static class` `PKIndexSplitter.DocumentFilteredIndexReader`
`class` `SegmentReader`

Fields in org.apache.lucene.index declared as IndexReader
`protected IndexReader` `FilterIndexReader.in`
`protected IndexReader[]` `MultiReader.subReaders`

Methods in org.apache.lucene.index that return IndexReader
`IndexReader` `IndexReader.clone(boolean openReadOnly)` Clones the IndexReader and optionally changes readOnly.
`IndexReader` `SegmentReader.clone(boolean openReadOnly)`
`protected IndexReader` `MultiReader.doReopen(boolean doClone)` If clone is true then we clone each of the subreaders
`protected IndexReader` `ParallelReader.doReopen(boolean doClone)`
`IndexReader` `IndexWriter.getReader()` Deprecated. Please use `open(IndexWriter,boolean)` instead.

`IndexReader`

`IndexWriter.getReader(int termInfosIndexDivisor)`
Deprecated. Please use `open(IndexWriter,boolean)` instead. Furthermore, this method cannot guarantee the reader (and its sub-readers) will be opened with the termInfosIndexDivisor setting because some of them may have already been opened according to `IndexWriterConfig.setReaderTermsIndexDivisor(int)`. You should set the requested termInfosIndexDivisor through `IndexWriterConfig.setReaderTermsIndexDivisor(int)` and use `IndexWriter.getReader()`.

`IndexReader[]` `PKIndexSplitter.DocumentFilteredIndexReader.getSequentialSubReaders()`
`IndexReader[]` `MultiPassIndexSplitter.FakeDeleteIndexReader.getSequentialSubReaders()`
`IndexReader[]` `MultiReader.getSequentialSubReaders()`
`IndexReader[]` `FilterIndexReader.getSequentialSubReaders()`
`IndexReader[]` `IndexReader.getSequentialSubReaders()` Expert: returns the sequential sub readers that this reader is logically composed of.
`static IndexReader` `IndexReader.open(Directory directory)` Returns a IndexReader reading the index in the given Directory, with readOnly=true.
`static IndexReader` `IndexReader.open(Directory directory, boolean readOnly)` Returns an IndexReader reading the index in the given Directory.
`static IndexReader` `IndexReader.open(Directory directory, IndexDeletionPolicy deletionPolicy, boolean readOnly)` Expert: returns an IndexReader reading the index in the given Directory, with a custom `IndexDeletionPolicy`.
`static IndexReader` `IndexReader.open(Directory directory, IndexDeletionPolicy deletionPolicy, boolean readOnly, int termInfosIndexDivisor)` Expert: returns an IndexReader reading the index in the given Directory, with a custom `IndexDeletionPolicy`.
`static IndexReader` `IndexReader.open(IndexCommit commit, boolean readOnly)` Expert: returns an IndexReader reading the index in the given `IndexCommit`.
`static IndexReader` `IndexReader.open(IndexCommit commit, IndexDeletionPolicy deletionPolicy, boolean readOnly)` Expert: returns an IndexReader reading the index in the given Directory, using a specific commit and with a custom `IndexDeletionPolicy`.
`static IndexReader` `IndexReader.open(IndexCommit commit, IndexDeletionPolicy deletionPolicy, boolean readOnly, int termInfosIndexDivisor)` Expert: returns an IndexReader reading the index in the given Directory, using a specific commit and with a custom `IndexDeletionPolicy`.
`static IndexReader` `IndexReader.open(IndexWriter writer, boolean applyAllDeletes)` Open a near real time IndexReader from the `IndexWriter`.
`IndexReader` `MultiReader.reopen()` Tries to reopen the subreaders.
`IndexReader` `ParallelReader.reopen()` Tries to reopen the subreaders.
`IndexReader` `IndexReader.reopen()` Refreshes an IndexReader if the index has changed since this instance was (re)opened.
`IndexReader` `SegmentReader.reopen()`
`IndexReader` `IndexReader.reopen(boolean openReadOnly)` Just like `reopen()`, except you can change the readOnly of the original reader.
`IndexReader` `SegmentReader.reopen(boolean openReadOnly)`
`IndexReader` `IndexReader.reopen(IndexCommit commit)` Expert: reopen this reader on a specific commit point.
`IndexReader` `IndexReader.reopen(IndexWriter writer, boolean applyAllDeletes)` Expert: returns a readonly reader, covering all committed as well as un-committed changes to the index.

Methods in org.apache.lucene.index with parameters of type IndexReader
`void` `TermVectorAccessor.accept(IndexReader indexReader, int documentNumber, String fieldName, TermVectorMapper mapper)` Visits the TermVectorMapper and populates it with terms available for a given document, either via a vector created at index time or by resolving them from the inverted index.
`void` `ParallelReader.add(IndexReader reader)` Add an IndexReader.
`void` `ParallelReader.add(IndexReader reader, boolean ignoreStoredFields)` Add an IndexReader whose stored fields will not be returned.
`void` `IndexWriter.addIndexes(IndexReader... readers)` Merges the provided indexes into this index.
`void` `IndexReader.ReaderFinishedListener.finished(IndexReader reader)`
`void` `MultiPassIndexSplitter.split(IndexReader input, Directory[] outputs, boolean seq)` Deprecated. use `MultiPassIndexSplitter.split(Version, IndexReader, Directory[], boolean)` instead. This method will be removed in Lucene 4.0.
`void` `MultiPassIndexSplitter.split(Version version, IndexReader input, Directory[] outputs, boolean seq)` Split source index into multiple parts.
`protected void` `NRTManager.warm(IndexReader reader)` Override this to warm the newly opened reader before it's swapped in.
`abstract void` `IndexWriter.IndexReaderWarmer.warm(IndexReader reader)`

Constructors in org.apache.lucene.index with parameters of type IndexReader
`FilterIndexReader(IndexReader in)` Construct a FilterIndexReader based on the specified base reader.
`MultiPassIndexSplitter.FakeDeleteIndexReader(IndexReader in)`
`MultipleTermPositions(IndexReader indexReader, Term[] terms)` Creates a new `MultipleTermPositions` instance.
`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.
`PKIndexSplitter.DocumentFilteredIndexReader(IndexReader reader, Filter preserveFilter, boolean negateFilter)`

Uses of IndexReader in org.apache.lucene.misc

Methods in org.apache.lucene.misc with parameters of type IndexReader
`static org.apache.lucene.misc.TermStats[]` `HighFreqTerms.getHighFreqTerms(IndexReader reader, int numTerms, String field)`
`static long` `HighFreqTerms.getTotalTermFreq(IndexReader reader, Term term)`
`static org.apache.lucene.misc.TermStats[]` `HighFreqTerms.sortByTotalTermFreq(IndexReader reader, org.apache.lucene.misc.TermStats[] terms)` Takes array of TermStats.

Uses of IndexReader in org.apache.lucene.queryParser.surround.query

Methods in org.apache.lucene.queryParser.surround.query that return IndexReader
`IndexReader` `SpanNearClauseFactory.getIndexReader()`

Methods in org.apache.lucene.queryParser.surround.query with parameters of type IndexReader
`Query` `DistanceQuery.getSpanNearQuery(IndexReader reader, String fieldName, float boost, BasicQueryFactory qf)`
`void` `SrndTermQuery.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)`
`abstract void` `SimpleTerm.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)`
`void` `SrndTruncQuery.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)`
`void` `SrndPrefixQuery.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)`

Constructors in org.apache.lucene.queryParser.surround.query with parameters of type IndexReader
`SpanNearClauseFactory(IndexReader reader, String fieldName, BasicQueryFactory qf)`

Uses of IndexReader in org.apache.lucene.search

Fields in org.apache.lucene.search declared as IndexReader
`protected IndexReader[]` `IndexSearcher.subReaders`

Methods in org.apache.lucene.search that return IndexReader
`IndexReader` `IndexSearcher.getIndexReader()` Return the `IndexReader` this searches.
`IndexReader[]` `IndexSearcher.getSubReaders()` Returns the atomic subReaders used by this searcher.

Methods in org.apache.lucene.search with parameters of type IndexReader
`SpanFilterResult` `SpanQueryFilter.bitSpans(IndexReader reader)`
`abstract SpanFilterResult` `SpanFilter.bitSpans(IndexReader reader)` Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.
`SpanFilterResult` `CachingSpanFilter.bitSpans(IndexReader reader)`
`protected DocIdSet` `CachingWrapperFilter.docIdSetToCache(DocIdSet docIdSet, IndexReader reader)` Provide the DocIdSet to be cached, using the DocIdSet provided by the wrapped Filter.
`Explanation` `BooleanQuery.BooleanWeight.explain(IndexReader reader, int doc)`
`Explanation` `ConstantScoreQuery.ConstantWeight.explain(IndexReader reader, int doc)`
`abstract Explanation` `Weight.explain(IndexReader reader, int doc)` An explanation of the score computation for the named document.
`Explanation` `DisjunctionMaxQuery.DisjunctionMaxWeight.explain(IndexReader reader, int doc)` Explain the score we computed for doc
`protected void` `IndexSearcher.gatherSubReaders(List<IndexReader> allSubReaders, IndexReader r)`
`byte[]` `FieldCache.getBytes(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as a single byte and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`byte[]` `FieldCache.getBytes(IndexReader reader, String field, FieldCache.ByteParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as bytes and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`DocIdSet` `RemoteCachingWrapperFilter.getDocIdSet(IndexReader reader)` Deprecated. Uses the `FilterManager` to keep the cache for a filter on the searcher side of a remote connection.
`DocIdSet` `TermsFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `DuplicateFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `BooleanFilter.getDocIdSet(IndexReader reader)` Returns the a DocIdSetIterator representing the Boolean composition of the filters that have been added.
`DocIdSet` `ChainedFilter.getDocIdSet(IndexReader reader)` `Filter.getDocIdSet(org.apache.lucene.index.IndexReader)`.
`DocIdSet` `SpanQueryFilter.getDocIdSet(IndexReader reader)`
`abstract DocIdSet` `Filter.getDocIdSet(IndexReader reader)` Creates a `DocIdSet` enumerating the documents that should be permitted in search results.
`DocIdSet` `FieldCacheTermsFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `CachingSpanFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `CachingWrapperFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `QueryWrapperFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `MultiTermQueryWrapperFilter.getDocIdSet(IndexReader reader)` Returns a DocIdSet with documents that should be permitted in search results.
`abstract DocIdSet` `FieldCacheRangeFilter.getDocIdSet(IndexReader reader)` This method is implemented for each data type
`double[]` `FieldCache.getDoubles(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`double[]` `FieldCache.getDoubles(IndexReader reader, String field, FieldCache.DoubleParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as doubles and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`protected FilteredTermEnum` `PrefixQuery.getEnum(IndexReader reader)`
`protected abstract FilteredTermEnum` `MultiTermQuery.getEnum(IndexReader reader)` Construct the enumeration to be used, expanding the pattern term.
`protected FilteredTermEnum` `TermRangeQuery.getEnum(IndexReader reader)`
`protected FilteredTermEnum` `FuzzyQuery.getEnum(IndexReader reader)`
`protected FilteredTermEnum` `NumericRangeQuery.getEnum(IndexReader reader)`
`protected FilteredTermEnum` `WildcardQuery.getEnum(IndexReader reader)`
`float[]` `FieldCache.getFloats(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as floats and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`float[]` `FieldCache.getFloats(IndexReader reader, String field, FieldCache.FloatParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as floats and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`int[]` `FieldCache.getInts(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`int[]` `FieldCache.getInts(IndexReader reader, String field, FieldCache.IntParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`long[]` `FieldCache.getLongs(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as longs and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`long[]` `FieldCache.getLongs(IndexReader reader, String field, FieldCache.LongParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as longs and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`short[]` `FieldCache.getShorts(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as shorts and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`short[]` `FieldCache.getShorts(IndexReader reader, String field, FieldCache.ShortParser parser)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as shorts and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
`FieldCache.StringIndex` `FieldCache.getStringIndex(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found reads the term values in `field` and returns an array of them in natural order, along with an array telling which element in the term array each document uses.
`String[]` `FieldCache.getStrings(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the term values in `field` and returns an array of size `reader.maxDoc()` containing the value each document has in the given field.
`DocIdSet` `FieldCache.getUnValuedDocs(IndexReader reader, String field)` Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` and returns a bit set at the size of `reader.maxDoc()`, with turned on bits for each docid that does not have a value for this field.
`void` `FieldCache.purge(IndexReader r)` Expert: drops all cache entries associated with this reader.
`Query` `BoostingQuery.rewrite(IndexReader reader)`
`Query` `FuzzyLikeThisQuery.rewrite(IndexReader reader)`
`Query` `BooleanQuery.rewrite(IndexReader reader)`
`Query` `MultiPhraseQuery.rewrite(IndexReader reader)`
`Query` `ConstantScoreQuery.rewrite(IndexReader reader)`
`Query` `Query.rewrite(IndexReader reader)` Expert: called to re-write queries into primitive queries.
`Query` `MultiTermQuery.rewrite(IndexReader reader)` To rewrite to a simpler form, instead return a simpler enum from `MultiTermQuery.getEnum(IndexReader)`.
`Query` `DisjunctionMaxQuery.rewrite(IndexReader reader)` Optimize our representation and our subqueries representations
`Query` `PhraseQuery.rewrite(IndexReader reader)`
`Query` `FilteredQuery.rewrite(IndexReader reader)` Rewrites the wrapped query.
`Q` `ScoringRewrite.rewrite(IndexReader reader, MultiTermQuery query)`
`abstract Query` `MultiTermQuery.RewriteMethod.rewrite(IndexReader reader, MultiTermQuery query)`
`Q` `TopTermsRewrite.rewrite(IndexReader reader, MultiTermQuery query)`
`Scorer` `BooleanQuery.BooleanWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)`
`Scorer` `ConstantScoreQuery.ConstantWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)`
`abstract Scorer` `Weight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)` Returns a `Scorer` which scores documents in/out-of order according to `scoreDocsInOrder`.
`Scorer` `DisjunctionMaxQuery.DisjunctionMaxWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)` Create the scorer used to score our associated DisjunctionMaxQuery
`void` `TotalHitCountCollector.setNextReader(IndexReader reader, int docBase)`
`abstract void` `FieldComparator.setNextReader(IndexReader reader, int docBase)` Set a new Reader.
`void` `FieldComparator.ByteComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.DocComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.DoubleComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.FloatComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.IntComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.LongComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.RelevanceComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.ShortComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.StringComparatorLocale.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.StringOrdValComparator.setNextReader(IndexReader reader, int docBase)`
`void` `FieldComparator.StringValComparator.setNextReader(IndexReader reader, int docBase)`
`void` `TimeLimitingCollector.setNextReader(IndexReader reader, int base)`
`void` `PositiveScoresOnlyCollector.setNextReader(IndexReader reader, int docBase)`
`void` `TopScoreDocCollector.setNextReader(IndexReader reader, int base)`
`void` `MultiCollector.setNextReader(IndexReader reader, int o)`
`abstract void` `Collector.setNextReader(IndexReader reader, int docBase)` Called before collecting from each IndexReader.
`void` `CachingCollector.setNextReader(IndexReader reader, int docBase)`

Method parameters in org.apache.lucene.search with type arguments of type IndexReader
`protected void` `IndexSearcher.gatherSubReaders(List<IndexReader> allSubReaders, IndexReader r)`

Constructors in org.apache.lucene.search with parameters of type IndexReader
`FuzzyTermEnum(IndexReader reader, Term term)` Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f.
`FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity)` Creates a FuzzyTermEnum with an empty prefix.
`FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity, int prefixLength)` Constructor for enumeration of all terms from specified `reader` which share a prefix of length `prefixLength` with `term` and which have a fuzzy similarity > `minSimilarity`.
`IndexSearcher(IndexReader r)` Creates a searcher searching the provided index.
`IndexSearcher(IndexReader r, ExecutorService executor)` Runs searches for each segment separately, using the provided ExecutorService.
`IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts)` Expert: directly specify the reader, subReaders and their docID starts.
`IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts)` Expert: directly specify the reader, subReaders and their docID starts.
`IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts, ExecutorService executor)` Expert: directly specify the reader, subReaders and their docID starts, and an ExecutorService.
`IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts, ExecutorService executor)` Expert: directly specify the reader, subReaders and their docID starts, and an ExecutorService.
`PrefixTermEnum(IndexReader reader, Term prefix)`
`SingleTermEnum(IndexReader reader, Term singleTerm)` Creates a new `SingleTermEnum`.
`TermRangeTermEnum(IndexReader reader, String field, String lowerTermText, String upperTermText, boolean includeLower, boolean includeUpper, Collator collator)` Enumerates all terms greater/equal than `lowerTerm` but less/equal than `upperTerm`.
`WildcardTermEnum(IndexReader reader, Term term)` Creates a new `WildcardTermEnum`.

Uses of IndexReader in org.apache.lucene.search.function

Fields in org.apache.lucene.search.function declared as IndexReader
`protected IndexReader` `CustomScoreProvider.reader`

Methods in org.apache.lucene.search.function with parameters of type IndexReader
`abstract DocValues` `FieldCacheSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)` Return cached DocValues for input field and reader.
`DocValues` `FloatFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)`
`DocValues` `ShortFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)`
`DocValues` `IntFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)`
`DocValues` `ByteFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)`
`protected CustomScoreProvider` `CustomScoreQuery.getCustomScoreProvider(IndexReader reader)` Returns a `CustomScoreProvider` that calculates the custom scores for the given `IndexReader`.
`DocValues` `FieldCacheSource.getValues(IndexReader reader)`
`abstract DocValues` `ValueSource.getValues(IndexReader reader)` Return the DocValues used by the function query.
`DocValues` `ReverseOrdFieldSource.getValues(IndexReader reader)`
`DocValues` `OrdFieldSource.getValues(IndexReader reader)`
`Query` `CustomScoreQuery.rewrite(IndexReader reader)`
`Query` `ValueSourceQuery.rewrite(IndexReader reader)`

Constructors in org.apache.lucene.search.function with parameters of type IndexReader
`CustomScoreProvider(IndexReader reader)` Creates a new instance of the provider class for the given `IndexReader`.

Uses of IndexReader in org.apache.lucene.search.grouping

Methods in org.apache.lucene.search.grouping with parameters of type IndexReader
`void` `BlockGroupingCollector.setNextReader(IndexReader reader, int docBase)`
`void` `TermFirstPassGroupingCollector.setNextReader(IndexReader reader, int docBase)`
`void` `TermSecondPassGroupingCollector.setNextReader(IndexReader reader, int docBase)`
`void` `AbstractFirstPassGroupingCollector.setNextReader(IndexReader reader, int docBase)`
`void` `AbstractSecondPassGroupingCollector.setNextReader(IndexReader reader, int docBase)`
`void` `TermAllGroupsCollector.setNextReader(IndexReader reader, int docBase)`

Uses of IndexReader in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight with parameters of type IndexReader
`static TokenStream` `TokenSources.getAnyTokenStream(IndexReader reader, int docId, String field, Analyzer analyzer)` A convenience method that tries a number of approaches to getting a token stream.
`static TokenStream` `TokenSources.getAnyTokenStream(IndexReader reader, int docId, String field, Document doc, Analyzer analyzer)` A convenience method that tries to first get a TermPositionVector for the specified docId, then, falls back to using the passed in `Document` to retrieve the TokenStream.
`static WeightedTerm[]` `QueryTermExtractor.getIdfWeightedTerms(Query query, IndexReader reader, String fieldName)` Extracts all terms texts of a given Query into an array of WeightedTerms
`static TokenStream` `TokenSources.getTokenStream(IndexReader reader, int docId, String field)`
`static TokenStream` `TokenSources.getTokenStream(IndexReader reader, int docId, String field, Analyzer analyzer)`
`Map<String,WeightedSpanTerm>` `WeightedSpanTermExtractor.getWeightedSpanTermsWithScores(Query query, TokenStream tokenStream, String fieldName, IndexReader reader)` Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.

Constructors in org.apache.lucene.search.highlight with parameters of type IndexReader
`QueryScorer(Query query, IndexReader reader, String field)`
`QueryScorer(Query query, IndexReader reader, String field, String defaultField)`
`QueryTermScorer(Query query, IndexReader reader, String fieldName)`

Uses of IndexReader in org.apache.lucene.search.join

Methods in org.apache.lucene.search.join with parameters of type IndexReader
`Query` `BlockJoinQuery.rewrite(IndexReader reader)`
`void` `BlockJoinCollector.setNextReader(IndexReader reader, int docBase)`

Uses of IndexReader in org.apache.lucene.search.payloads

Methods in org.apache.lucene.search.payloads with parameters of type IndexReader
`Scorer` `PayloadNearQuery.PayloadNearSpanWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)`
`Scorer` `PayloadTermQuery.PayloadTermWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)`

Constructors in org.apache.lucene.search.payloads with parameters of type IndexReader
`PayloadSpanUtil(IndexReader reader)`

Uses of IndexReader in org.apache.lucene.search.regex

Methods in org.apache.lucene.search.regex with parameters of type IndexReader
`protected FilteredTermEnum` `RegexQuery.getEnum(IndexReader reader)`

Constructors in org.apache.lucene.search.regex with parameters of type IndexReader
`RegexTermEnum(IndexReader reader, Term term, RegexCapabilities regexImpl)`

Uses of IndexReader in org.apache.lucene.search.similar

Methods in org.apache.lucene.search.similar with parameters of type IndexReader
`Query` `MoreLikeThisQuery.rewrite(IndexReader reader)`

Constructors in org.apache.lucene.search.similar with parameters of type IndexReader
`MoreLikeThis(IndexReader ir)` Constructor requiring an IndexReader.
`MoreLikeThis(IndexReader ir, Similarity sim)`

Uses of IndexReader in org.apache.lucene.search.spans

Methods in org.apache.lucene.search.spans with parameters of type IndexReader
`Explanation` `SpanWeight.explain(IndexReader reader, int doc)`
`Spans` `SpanMultiTermQueryWrapper.getSpans(IndexReader reader)`
`Spans` `FieldMaskingSpanQuery.getSpans(IndexReader reader)`
`Spans` `SpanTermQuery.getSpans(IndexReader reader)`
`Spans` `SpanNotQuery.getSpans(IndexReader reader)`
`Spans` `SpanNearQuery.getSpans(IndexReader reader)`
`Spans` `SpanOrQuery.getSpans(IndexReader reader)`
`abstract Spans` `SpanQuery.getSpans(IndexReader reader)` Expert: Returns the matches for this query in an index.
`Spans` `SpanPositionCheckQuery.getSpans(IndexReader reader)`
`Query` `SpanMultiTermQueryWrapper.rewrite(IndexReader reader)`
`Query` `FieldMaskingSpanQuery.rewrite(IndexReader reader)`
`Query` `SpanNotQuery.rewrite(IndexReader reader)`
`Query` `SpanNearQuery.rewrite(IndexReader reader)`
`Query` `SpanOrQuery.rewrite(IndexReader reader)`
`Query` `SpanPositionCheckQuery.rewrite(IndexReader reader)`
`abstract SpanQuery` `SpanMultiTermQueryWrapper.SpanRewriteMethod.rewrite(IndexReader reader, MultiTermQuery query)`
`SpanQuery` `SpanMultiTermQueryWrapper.TopTermsSpanBooleanQueryRewrite.rewrite(IndexReader reader, MultiTermQuery query)`
`Scorer` `SpanWeight.scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)`

Constructors in org.apache.lucene.search.spans with parameters of type IndexReader
`NearSpansOrdered(SpanNearQuery spanNearQuery, IndexReader reader)`
`NearSpansOrdered(SpanNearQuery spanNearQuery, IndexReader reader, boolean collectPayloads)`
`NearSpansUnordered(SpanNearQuery query, IndexReader reader)`
`SpanPositionCheckQuery.PositionCheckSpan(IndexReader reader)`

Uses of IndexReader in org.apache.lucene.search.spell

Methods in org.apache.lucene.search.spell with parameters of type IndexReader
`String[]` `SpellChecker.suggestSimilar(String word, int numSug, IndexReader ir, String field, boolean morePopular)` Suggest similar words (optionally restricted to a field of an index).
`String[]` `SpellChecker.suggestSimilar(String word, int numSug, IndexReader ir, String field, boolean morePopular, float accuracy)` Suggest similar words (optionally restricted to a field of an index).

Constructors in org.apache.lucene.search.spell with parameters of type IndexReader
`HighFrequencyDictionary(IndexReader reader, String field, float thresh)`
`LuceneDictionary(IndexReader reader, String field)`

Uses of IndexReader in org.apache.lucene.search.vectorhighlight

Methods in org.apache.lucene.search.vectorhighlight with parameters of type IndexReader
`String` `BaseFragmentsBuilder.createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList)`
`String` `FragmentsBuilder.createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList)` create a fragment.
`String` `BaseFragmentsBuilder.createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, String[] preTags, String[] postTags, Encoder encoder)`
`String` `FragmentsBuilder.createFragment(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, String[] preTags, String[] postTags, Encoder encoder)` create a fragment.
`String[]` `BaseFragmentsBuilder.createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments)`
`String[]` `FragmentsBuilder.createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments)` create multiple fragments.
`String[]` `BaseFragmentsBuilder.createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags, Encoder encoder)`
`String[]` `FragmentsBuilder.createFragments(IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags, Encoder encoder)` create multiple fragments.
`String` `FastVectorHighlighter.getBestFragment(FieldQuery fieldQuery, IndexReader reader, int docId, String fieldName, int fragCharSize)` return the best fragment.
`String` `FastVectorHighlighter.getBestFragment(FieldQuery fieldQuery, IndexReader reader, int docId, String fieldName, int fragCharSize, FragListBuilder fragListBuilder, FragmentsBuilder fragmentsBuilder, String[] preTags, String[] postTags, Encoder encoder)` return the best fragment.
`String[]` `FastVectorHighlighter.getBestFragments(FieldQuery fieldQuery, IndexReader reader, int docId, String fieldName, int fragCharSize, int maxNumFragments)` return the best fragments.
`String[]` `FastVectorHighlighter.getBestFragments(FieldQuery fieldQuery, IndexReader reader, int docId, String fieldName, int fragCharSize, int maxNumFragments, FragListBuilder fragListBuilder, FragmentsBuilder fragmentsBuilder, String[] preTags, String[] postTags, Encoder encoder)` return the best fragments.
`protected Field[]` `BaseFragmentsBuilder.getFields(IndexReader reader, int docId, String fieldName)`
`protected String[]` `BaseFragmentsBuilder.getFieldValues(IndexReader reader, int docId, String fieldName)` Deprecated.

Constructors in org.apache.lucene.search.vectorhighlight with parameters of type IndexReader
`FieldTermStack(IndexReader reader, int docId, String fieldName, FieldQuery fieldQuery)` a constructor.

Uses of IndexReader in org.apache.lucene.spatial.geohash

Methods in org.apache.lucene.spatial.geohash with parameters of type IndexReader
`DocIdSet` `GeoHashDistanceFilter.getDocIdSet(IndexReader reader)`

Uses of IndexReader in org.apache.lucene.spatial.tier

Methods in org.apache.lucene.spatial.tier with parameters of type IndexReader
`DocIdSet` `CartesianShapeFilter.getDocIdSet(IndexReader reader)`
`DocIdSet` `LatLongDistanceFilter.getDocIdSet(IndexReader reader)`

Uses of IndexReader in org.apache.lucene.store.instantiated

Subclasses of IndexReader in org.apache.lucene.store.instantiated
`class` `InstantiatedIndexReader` An InstantiatedIndexReader is not a snapshot in time, it is completely in sync with the latest commit to the store!

Methods in org.apache.lucene.store.instantiated with parameters of type IndexReader
`void` `InstantiatedIndexWriter.addIndexes(IndexReader[] readers)`

Constructors in org.apache.lucene.store.instantiated with parameters of type IndexReader
`InstantiatedIndex(IndexReader sourceIndexReader)` Creates a new instantiated index that looks just like the index in a specific state as represented by a reader.
`InstantiatedIndex(IndexReader sourceIndexReader, Set<String> fields)` Creates a new instantiated index that looks just like the index in a specific state as represented by a reader.

Uses of IndexReader in org.apache.lucene.util

Methods in org.apache.lucene.util that return IndexReader
`static IndexReader` `ReaderUtil.subReader(IndexReader reader, int subIndex)` Returns sub-reader subIndex from reader.
`static IndexReader` `ReaderUtil.subReader(int doc, IndexReader reader)` Returns sub IndexReader that contains the given document id.

Methods in org.apache.lucene.util with parameters of type IndexReader
`protected abstract void` `ReaderUtil.Gather.add(int base, IndexReader r)`
`static void` `ReaderUtil.gatherSubReaders(List<IndexReader> allSubReaders, IndexReader reader)` Gathers sub-readers from reader into a List.
`static IndexReader` `ReaderUtil.subReader(IndexReader reader, int subIndex)` Returns sub-reader subIndex from reader.
`static IndexReader` `ReaderUtil.subReader(int doc, IndexReader reader)` Returns sub IndexReader that contains the given document id.

Method parameters in org.apache.lucene.util with type arguments of type IndexReader
`static void` `ReaderUtil.gatherSubReaders(List<IndexReader> allSubReaders, IndexReader reader)` Gathers sub-readers from reader into a List.

Constructors in org.apache.lucene.util with parameters of type IndexReader
`ReaderUtil.Gather(IndexReader r)`

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.