Package | Description |
---|---|
org.apache.lucene.analysis.query | |
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.
|
org.apache.lucene.store.instantiated |
InstantiatedIndex, alternative RAM store for small corpora.
|
Modifier and Type | Method and Description |
---|---|
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
|
Modifier and Type | Method and Description |
---|---|
IndexReader |
PerfRunData.getIndexReader() |
Modifier and Type | Method and Description |
---|---|
void |
PerfRunData.setIndexReader(IndexReader indexReader) |
Modifier and Type | Method and Description |
---|---|
protected Document |
ReadTask.retrieveDoc(IndexReader ir,
int id) |
protected Document |
SearchTravRetLoadFieldSelectorTask.retrieveDoc(IndexReader ir,
int id) |
Modifier and Type | Class and Description |
---|---|
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.
|
Modifier and Type | Field and Description |
---|---|
protected IndexReader |
FilterIndexReader.in |
protected IndexReader |
IndexModifier.indexReader
Deprecated.
|
protected IndexReader[] |
MultiReader.subReaders |
Modifier and Type | Method and Description |
---|---|
static IndexReader |
IndexReader.open(Directory directory)
Returns a read/write IndexReader reading the index in
the given Directory.
|
static IndexReader |
IndexReader.open(Directory directory,
boolean readOnly)
Returns a read/write or read only IndexReader reading the index in the given Directory.
|
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy)
Expert: returns a read/write IndexReader reading the index in the given
Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Expert: returns a read/write or read only IndexReader reading the index in the given
Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(File path)
Returns a read/write IndexReader reading the index in an FSDirectory in the named
path.
|
static IndexReader |
IndexReader.open(IndexCommit commit)
Expert: returns a read/write IndexReader reading the index in the given
IndexCommit . |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy)
Expert: returns a read/write 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)
Expert: returns a read/write or read only IndexReader reading the index in the given
Directory, using a specific commit and with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(String path)
Returns a read/write 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 |
MultiReader.reopen()
Tries to reopen the subreaders.
|
IndexReader |
ParallelReader.reopen()
Tries to reopen the subreaders.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
DocIdSet |
ChainedFilter.getDocIdSet(IndexReader reader)
|
Modifier and Type | Method and Description |
---|---|
IndexReader |
SpanNearClauseFactory.getIndexReader() |
Modifier and Type | Method and Description |
---|---|
Query |
DistanceQuery.getSpanNearQuery(IndexReader reader,
String fieldName,
float boost,
BasicQueryFactory qf) |
void |
SrndTruncQuery.visitMatchingTerms(IndexReader reader,
String fieldName,
SimpleTerm.MatchingTermVisitor mtv) |
void |
SrndTermQuery.visitMatchingTerms(IndexReader reader,
String fieldName,
SimpleTerm.MatchingTermVisitor mtv) |
void |
SrndPrefixQuery.visitMatchingTerms(IndexReader reader,
String fieldName,
SimpleTerm.MatchingTermVisitor mtv) |
abstract void |
SimpleTerm.visitMatchingTerms(IndexReader reader,
String fieldName,
SimpleTerm.MatchingTermVisitor mtv) |
Constructor and Description |
---|
SpanNearClauseFactory(IndexReader reader,
String fieldName,
BasicQueryFactory qf) |
Modifier and Type | Method and Description |
---|---|
IndexReader |
IndexSearcher.getIndexReader()
Return the
IndexReader this searches. |
Modifier and Type | Method and Description |
---|---|
BitSet |
TermsFilter.bits(IndexReader reader) |
BitSet |
QueryWrapperFilter.bits(IndexReader reader)
Deprecated.
Use
QueryWrapperFilter.getDocIdSet(IndexReader) instead. |
BitSet |
Filter.bits(IndexReader reader)
Deprecated.
Use
Filter.getDocIdSet(IndexReader) instead. |
BitSet |
PrefixFilter.bits(IndexReader reader)
Deprecated.
Use
PrefixFilter.getDocIdSet(IndexReader) instead. |
BitSet |
RangeFilter.bits(IndexReader reader)
Deprecated.
Use
RangeFilter.getDocIdSet(IndexReader) instead. |
BitSet |
CachingSpanFilter.bits(IndexReader reader)
Deprecated.
Use
CachingSpanFilter.getDocIdSet(IndexReader) instead. |
BitSet |
CachingWrapperFilter.bits(IndexReader reader)
Deprecated.
Use
CachingWrapperFilter.getDocIdSet(IndexReader) instead. |
BitSet |
RemoteCachingWrapperFilter.bits(IndexReader reader)
Deprecated.
Use
RemoteCachingWrapperFilter.getDocIdSet(IndexReader) instead. |
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) |
SpanFilterResult |
SpanQueryFilter.bitSpans(IndexReader reader) |
Explanation |
ConstantScoreQuery.ConstantWeight.explain(IndexReader reader,
int doc) |
Explanation |
Weight.explain(IndexReader reader,
int doc)
An explanation of the score computation for the named document.
|
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. |
DocIdSet |
DuplicateFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
TermsFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
BooleanFilter.getDocIdSet(IndexReader reader)
Returns the a DocIdSetIterator representing the Boolean composition
of the filters that have been added.
|
DocIdSet |
QueryWrapperFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
Filter.getDocIdSet(IndexReader reader) |
DocIdSet |
PrefixFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
RangeFilter.getDocIdSet(IndexReader reader)
Returns a DocIdSet with documents that should be
permitted in search results.
|
DocIdSet |
CachingSpanFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
CachingWrapperFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
SpanQueryFilter.getDocIdSet(IndexReader reader) |
DocIdSet |
RemoteCachingWrapperFilter.getDocIdSet(IndexReader reader)
Uses the
FilterManager to keep the cache for a filter on the
searcher side of a remote connection. |
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 |
SortComparator.newComparator(IndexReader reader,
String fieldname) |
ScoreDocComparator |
SortComparatorSource.newComparator(IndexReader reader,
String fieldname)
Creates a comparator for the field in the given index.
|
Query |
BoostingQuery.rewrite(IndexReader reader) |
Query |
FuzzyLikeThisQuery.rewrite(IndexReader reader) |
Query |
MultiTermQuery.rewrite(IndexReader reader) |
Query |
WildcardQuery.rewrite(IndexReader reader) |
Query |
ConstantScoreQuery.rewrite(IndexReader reader) |
Query |
FilteredQuery.rewrite(IndexReader reader)
Rewrites the wrapped query.
|
Query |
ConstantScoreRangeQuery.rewrite(IndexReader reader) |
Query |
MultiPhraseQuery.rewrite(IndexReader reader) |
Query |
RangeQuery.rewrite(IndexReader reader) |
Query |
Query.rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.
|
Query |
FuzzyQuery.rewrite(IndexReader reader) |
Query |
PrefixQuery.rewrite(IndexReader reader) |
Query |
BooleanQuery.rewrite(IndexReader reader) |
Query |
DisjunctionMaxQuery.rewrite(IndexReader reader)
Optimize our representation and our subqueries representations
|
Scorer |
ConstantScoreQuery.ConstantWeight.scorer(IndexReader reader) |
Scorer |
Weight.scorer(IndexReader reader)
Constructs a scorer for this.
|
Constructor and Description |
---|
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 . |
Modifier and Type | Method and Description |
---|---|
DocValues |
IntFieldSource.getCachedFieldValues(FieldCache cache,
String field,
IndexReader reader) |
DocValues |
FloatFieldSource.getCachedFieldValues(FieldCache cache,
String field,
IndexReader reader) |
DocValues |
ByteFieldSource.getCachedFieldValues(FieldCache cache,
String field,
IndexReader reader) |
DocValues |
ShortFieldSource.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.
|
abstract DocValues |
ValueSource.getValues(IndexReader reader)
Return the DocValues used by the function query.
|
DocValues |
OrdFieldSource.getValues(IndexReader reader) |
DocValues |
ReverseOrdFieldSource.getValues(IndexReader reader) |
DocValues |
FieldCacheSource.getValues(IndexReader reader) |
Query |
ValueSourceQuery.rewrite(IndexReader reader) |
Query |
CustomScoreQuery.rewrite(IndexReader reader) |
Modifier and Type | Method and Description |
---|---|
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 |
WeightedSpanTermExtractor.getWeightedSpanTermsWithScores(Query query,
TokenStream tokenStream,
String fieldName,
IndexReader reader)
Creates a Map of
WeightedSpanTerms from the given Query and TokenStream . |
Constructor and Description |
---|
QueryScorer(Query query,
IndexReader reader,
String fieldName) |
SpanScorer(Query query,
String field,
CachingTokenFilter cachingTokenFilter,
IndexReader reader) |
SpanScorer(Query query,
String field,
CachingTokenFilter cachingTokenFilter,
IndexReader reader,
String defaultField)
As above, but with ability to pass in an IndexReader
|
Modifier and Type | Method and Description |
---|---|
Scorer |
BoostingTermQuery.BoostingTermWeight.scorer(IndexReader reader) |
Constructor and Description |
---|
PayloadSpanUtil(IndexReader reader) |
Modifier and Type | Method and Description |
---|---|
protected FilteredTermEnum |
RegexQuery.getEnum(IndexReader reader) |
PayloadSpans |
SpanRegexQuery.getPayloadSpans(IndexReader reader) |
Spans |
SpanRegexQuery.getSpans(IndexReader reader) |
Query |
SpanRegexQuery.rewrite(IndexReader reader) |
Constructor and Description |
---|
RegexTermEnum(IndexReader reader,
Term term,
RegexCapabilities regexImpl) |
Modifier and Type | Method and Description |
---|---|
Query |
MoreLikeThisQuery.rewrite(IndexReader reader) |
Constructor and Description |
---|
MoreLikeThis(IndexReader ir)
Constructor requiring an IndexReader.
|
MoreLikeThis(IndexReader ir,
Similarity sim) |
Modifier and Type | Method and Description |
---|---|
Explanation |
SpanWeight.explain(IndexReader reader,
int doc) |
PayloadSpans |
SpanNotQuery.getPayloadSpans(IndexReader reader) |
PayloadSpans |
SpanOrQuery.getPayloadSpans(IndexReader reader) |
PayloadSpans |
SpanQuery.getPayloadSpans(IndexReader reader)
Returns the matches for this query in an index, including access to any
Payload s at those
positions. |
PayloadSpans |
SpanTermQuery.getPayloadSpans(IndexReader reader) |
PayloadSpans |
SpanFirstQuery.getPayloadSpans(IndexReader reader) |
PayloadSpans |
SpanNearQuery.getPayloadSpans(IndexReader reader) |
Spans |
SpanNotQuery.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 |
SpanTermQuery.getSpans(IndexReader reader) |
Spans |
SpanFirstQuery.getSpans(IndexReader reader) |
Spans |
SpanNearQuery.getSpans(IndexReader reader) |
Query |
SpanNotQuery.rewrite(IndexReader reader) |
Query |
SpanOrQuery.rewrite(IndexReader reader) |
Query |
SpanFirstQuery.rewrite(IndexReader reader) |
Query |
SpanNearQuery.rewrite(IndexReader reader) |
Scorer |
SpanWeight.scorer(IndexReader reader) |
Modifier and Type | Method and Description |
---|---|
String[] |
SpellChecker.suggestSimilar(String word,
int numSug,
IndexReader ir,
String field,
boolean morePopular)
Suggest similar words (optionally restricted to a field of an index).
|
Constructor and Description |
---|
LuceneDictionary(IndexReader reader,
String field) |
Modifier and Type | Class and Description |
---|---|
class |
InstantiatedIndexReader
An InstantiatedIndexReader is not a snapshot in time, it is completely in
sync with the latest commit to the store!
|
Modifier and Type | Method and Description |
---|---|
void |
InstantiatedIndexWriter.addIndexes(IndexReader[] readers) |
Constructor and Description |
---|
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.
|
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.