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

Packages that use IndexReader

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.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.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.

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

protected int	SearchTravRetLoadFieldSelectorTask.retrieveDoc(IndexReader ir, int id)
protected int	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.
class	MultiReader An IndexReader which reads multiple indexes, appending their content.
class	ParallelReader An IndexReader which reads multiple, parallel indexes.

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

protected IndexReader	FilterIndexReader.in
protected IndexReader	IndexModifier.indexReader Deprecated.
protected IndexReader[]	MultiReader.subReaders

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

static IndexReader	IndexReader.open(Directory directory) Returns an IndexReader reading the index in the given Directory.
static IndexReader	IndexReader.open(Directory directory, IndexDeletionPolicy deletionPolicy) Expert: returns an IndexReader reading the index in the given Directory, with a custom IndexDeletionPolicy.
static IndexReader	IndexReader.open(File path) Returns an IndexReader reading the index in an FSDirectory in the named path.
static IndexReader	IndexReader.open(String path) Returns an IndexReader reading the index in an FSDirectory in the named path.
IndexReader	IndexReader.reopen() Refreshes an IndexReader if the index has changed since this instance was (re)opened.
IndexReader	ParallelReader.reopen() Tries to reopen the subreaders.
IndexReader	MultiReader.reopen() Tries to reopen the subreaders.

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

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.

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

FilterIndexReader(IndexReader in)
Construct a FilterIndexReader based on the specified base reader.

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.

Uses of IndexReader in org.apache.lucene.misc

Methods in org.apache.lucene.misc with parameters of type IndexReader

BitSet

ChainedFilter.bits(IndexReader reader) Filter.bits(org.apache.lucene.index.IndexReader).

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)
void	SrndPrefixQuery.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)
void	SrndTruncQuery.visitMatchingTerms(IndexReader reader, String fieldName, SimpleTerm.MatchingTermVisitor mtv)
abstract void	SimpleTerm.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

Methods in org.apache.lucene.search that return IndexReader

IndexReader

IndexSearcher.getIndexReader() Return the IndexReader this searches.

Methods in org.apache.lucene.search with parameters of type IndexReader

BitSet	DuplicateFilter.bits(IndexReader reader)
BitSet	BooleanFilter.bits(IndexReader reader) Returns the a BitSet representing the Boolean composition of the filters that have been added.
BitSet	TermsFilter.bits(IndexReader reader)
BitSet	PrefixFilter.bits(IndexReader reader)
abstract BitSet	Filter.bits(IndexReader reader) Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
BitSet	CachingSpanFilter.bits(IndexReader reader)
BitSet	CachingWrapperFilter.bits(IndexReader reader)
BitSet	RangeFilter.bits(IndexReader reader) Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
BitSet	QueryWrapperFilter.bits(IndexReader reader)
BitSet	SpanQueryFilter.bits(IndexReader reader)
BitSet	RemoteCachingWrapperFilter.bits(IndexReader reader) Uses the FilterManager to keep the cache for a filter on the searcher side of a remote connection.
SpanFilterResult	CachingSpanFilter.bitSpans(IndexReader reader)
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.
Explanation	Weight.explain(IndexReader reader, int doc) An explanation of the score computation for the named document.
Explanation	ConstantScoreQuery.ConstantWeight.explain(IndexReader reader, int doc)
Object	FieldCache.getAuto(IndexReader reader, String field) Checks the internal cache for an appropriate entry, and if none is found reads field to see if it contains integers, floats or strings, and then calls one of the other methods in this class to get the values.
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.
Comparable[]	FieldCache.getCustom(IndexReader reader, String field, SortComparator comparator) Checks the internal cache for an appropriate entry, and if none is found reads the terms out of field and calls the given SortComparator to get the sort values.
double[]	ExtendedFieldCache.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[]	ExtendedFieldCache.getDoubles(IndexReader reader, String field, ExtendedFieldCache.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 abstract FilteredTermEnum	MultiTermQuery.getEnum(IndexReader reader) Construct the enumeration to be used, expanding the pattern term.
protected FilteredTermEnum	WildcardQuery.getEnum(IndexReader reader)
protected FilteredTermEnum	FuzzyQuery.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[]	ExtendedFieldCache.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[]	ExtendedFieldCache.getLongs(IndexReader reader, String field, ExtendedFieldCache.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.
ScoreDocComparator	SortComparatorSource.newComparator(IndexReader reader, String fieldname) Creates a comparator for the field in the given index.
ScoreDocComparator	SortComparator.newComparator(IndexReader reader, String fieldname)
Query	FuzzyLikeThisQuery.rewrite(IndexReader reader)
Query	BoostingQuery.rewrite(IndexReader reader)
Query	ConstantScoreRangeQuery.rewrite(IndexReader reader)
Query	FilteredQuery.rewrite(IndexReader reader) Rewrites the wrapped query.
Query	Query.rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
Query	PrefixQuery.rewrite(IndexReader reader)
Query	MultiTermQuery.rewrite(IndexReader reader)
Query	WildcardQuery.rewrite(IndexReader reader)
Query	ConstantScoreQuery.rewrite(IndexReader reader)
Query	RangeQuery.rewrite(IndexReader reader)
Query	MultiPhraseQuery.rewrite(IndexReader reader)
Query	FuzzyQuery.rewrite(IndexReader reader)
Query	BooleanQuery.rewrite(IndexReader reader)
Query	DisjunctionMaxQuery.rewrite(IndexReader reader) Optimize our representation and our subqueries representations
Scorer	Weight.scorer(IndexReader reader) Constructs a scorer for this.
Scorer	ConstantScoreQuery.ConstantWeight.scorer(IndexReader reader)

Constructors in org.apache.lucene.search with parameters of type IndexReader

ConstantScoreQuery.ConstantScorer(Similarity similarity, IndexReader reader, Weight w)

FieldSortedHitQueue(IndexReader reader, SortField[] fields, int size)
Creates a hit queue sorted by the given list of fields.

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.

TopFieldDocCollector(IndexReader reader, Sort sort, int numHits)
Construct to collect a given number of hits.

WildcardTermEnum(IndexReader reader, Term term)
Creates a new WildcardTermEnum.

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

Methods in org.apache.lucene.search.function with parameters of type IndexReader

DocValues	IntFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)
DocValues	ByteFieldSource.getCachedFieldValues(FieldCache cache, String field, IndexReader reader)
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	OrdFieldSource.getValues(IndexReader reader)
DocValues	ReverseOrdFieldSource.getValues(IndexReader reader)
DocValues	FieldCacheSource.getValues(IndexReader reader)
abstract DocValues	ValueSource.getValues(IndexReader reader) Return the DocValues used by the function query.
Query	CustomScoreQuery.rewrite(IndexReader reader)
Query	ValueSourceQuery.rewrite(IndexReader reader)

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 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)

Constructors in org.apache.lucene.search.highlight with parameters of type IndexReader

QueryScorer(Query query, IndexReader reader, String fieldName)

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

Methods in org.apache.lucene.search.payloads with parameters of type IndexReader

Scorer

BoostingTermQuery.BoostingTermWeight.scorer(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)
Spans	SpanRegexQuery.getSpans(IndexReader reader)
Query	SpanRegexQuery.rewrite(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.

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	SpanNotQuery.getSpans(IndexReader reader)
Spans	SpanTermQuery.getSpans(IndexReader reader)
abstract Spans	SpanQuery.getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
Spans	SpanOrQuery.getSpans(IndexReader reader)
Spans	SpanNearQuery.getSpans(IndexReader reader)
Spans	SpanFirstQuery.getSpans(IndexReader reader)
Query	SpanNotQuery.rewrite(IndexReader reader)
Query	SpanOrQuery.rewrite(IndexReader reader)
Query	SpanNearQuery.rewrite(IndexReader reader)
Query	SpanFirstQuery.rewrite(IndexReader reader)
Scorer	SpanWeight.scorer(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).

Constructors in org.apache.lucene.search.spell with parameters of type IndexReader

LuceneDictionary(IndexReader reader, String field)