Uses of Class
org.apache.lucene.index.LeafReader
-
Packages that use LeafReader Package Description org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.index Code to maintain and access indices.org.apache.lucene.index.memory High-performance single-document main memory Apache Lucene fulltext search index.org.apache.lucene.monitor Monitoring frameworkorg.apache.lucene.search Code to search indices.org.apache.lucene.search.highlight Highlighting search terms.org.apache.lucene.search.join Support for index-time and query-time joins.org.apache.lucene.search.suggest.document Support for document suggestionorg.apache.lucene.search.uhighlight The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis. -
-
Uses of LeafReader in org.apache.lucene.document
Methods in org.apache.lucene.document with parameters of type LeafReader Modifier and Type Method Description private Scorer
ShapeQuery.RelationScorerSupplier. getContainsDenseScorer(LeafReader reader, Weight weight, float boost, ScoreMode scoreMode)
private Scorer
ShapeQuery.RelationScorerSupplier. getDenseScorer(LeafReader reader, Weight weight, float boost, ScoreMode scoreMode)
Scorer used for WITHIN and DISJOINTprotected Scorer
ShapeQuery.RelationScorerSupplier. getScorer(LeafReader reader, Weight weight, float boost, ScoreMode scoreMode)
private Scorer
ShapeQuery.RelationScorerSupplier. getSparseScorer(LeafReader reader, Weight weight, float boost, ScoreMode scoreMode)
Scorer used for INTERSECTSprivate BinaryRangeDocValues
BinaryRangeFieldRangeQuery. getValues(LeafReader reader, java.lang.String field)
(package private) abstract SortedNumericDocValues
SortedNumericDocValuesRangeQuery. getValues(LeafReader reader, java.lang.String field)
(package private) abstract SortedSetDocValues
SortedSetDocValuesRangeQuery. getValues(LeafReader reader, java.lang.String field)
-
Uses of LeafReader in org.apache.lucene.index
Subclasses of LeafReader in org.apache.lucene.index Modifier and Type Class Description class
CodecReader
LeafReader implemented by codec APIs.(package private) class
DocValuesLeafReader
static class
ExitableDirectoryReader.ExitableFilterAtomicReader
Wrapper class for another FilterAtomicReader.class
FilterCodecReader
AFilterCodecReader
contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.class
FilterLeafReader
AFilterLeafReader
contains another LeafReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.(package private) class
MergeReaderWrapper
This is a hack to make index sorting fast, with aLeafReader
that always returns merge instances when you ask for the codec readers.private static class
MultiPassIndexSplitter.FakeDeleteLeafIndexReader
class
ParallelLeafReader
AnLeafReader
which reads multiple, parallel indexes.private static class
PKIndexSplitter.DocumentFilteredLeafIndexReader
class
SegmentReader
IndexReader implementation over a single segment.(package private) static class
SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader
(package private) static class
SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterLeafReader
(package private) class
SortingLeafReader
AnLeafReader
which supports sorting documents by a givenSort
.Fields in org.apache.lucene.index declared as LeafReader Modifier and Type Field Description protected LeafReader
FilterLeafReader. in
The underlying LeafReader.private LeafReader[]
ParallelLeafReader. parallelReaders
private LeafReader
LeafReaderContext. reader
private LeafReader
SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader. reader
private LeafReader
SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterLeafReader. reader
private LeafReader[]
ParallelLeafReader. storedFieldsReaders
Fields in org.apache.lucene.index with type parameters of type LeafReader Modifier and Type Field Description private java.util.Set<LeafReader>
ParallelLeafReader. completeReaderSet
private java.util.SortedMap<java.lang.String,LeafReader>
ParallelLeafReader. fieldToReader
private java.util.Map<IndexReader.CacheKey,LeafReader>
SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper. mapping
private java.util.Map<java.lang.String,LeafReader>
ParallelLeafReader. termsFieldToReader
private java.util.SortedMap<java.lang.String,LeafReader>
ParallelLeafReader. tvFieldToReader
Methods in org.apache.lucene.index that return LeafReader Modifier and Type Method Description LeafReader
FilterLeafReader. getDelegate()
Returns the wrappedLeafReader
.private LeafReader
DefaultIndexingChain. getDocValuesLeafReader()
LeafReader[]
ParallelLeafReader. getParallelReaders()
Returns theLeafReader
s that were passed on init.private static LeafReader[]
ParallelCompositeReader. prepareLeafReaders(CompositeReader[] readers, CompositeReader[] storedFieldsReaders)
LeafReader
LeafReaderContext. reader()
static LeafReader
FilterLeafReader. unwrap(LeafReader reader)
Get the wrapped instance byreader
as long as this reader is an instance ofFilterLeafReader
.LeafReader
ExitableDirectoryReader.ExitableSubReaderWrapper. wrap(LeafReader reader)
protected LeafReader[]
FilterDirectoryReader.SubReaderWrapper. wrap(java.util.List<? extends LeafReader> readers)
Wraps a list of LeafReadersabstract LeafReader
FilterDirectoryReader.SubReaderWrapper. wrap(LeafReader reader)
Wrap one of the parent DirectoryReader's subreadersprotected LeafReader[]
SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper. wrap(java.util.List<? extends LeafReader> readers)
LeafReader
SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper. wrap(LeafReader reader)
(package private) static LeafReader
SoftDeletesDirectoryReaderWrapper. wrap(LeafReader reader, java.lang.String field)
(package private) static LeafReader
SortingLeafReader. wrap(LeafReader reader, Sorter.DocMap docMap)
Expert: same asSortingLeafReader.wrap(org.apache.lucene.index.LeafReader, Sort)
but operates directly on aSorter.DocMap
.static LeafReader
SortingLeafReader. wrap(LeafReader reader, Sort sort)
Return a sorted view ofreader
according to the order defined bysort
.Methods in org.apache.lucene.index with parameters of type LeafReader Modifier and Type Method Description private static boolean
SoftDeletesDirectoryReaderWrapper. assertDocCounts(int expectedNumDocs, int numSoftDeletes, LeafReader reader)
private static void
DocValues. checkField(LeafReader in, java.lang.String field, DocValuesType... expected)
NumericDocValues
IndexSorter.NumericDocValuesProvider. get(LeafReader reader)
Returns the NumericDocValues instance for this LeafReaderSortedDocValues
IndexSorter.SortedDocValuesProvider. get(LeafReader reader)
Returns the SortedDocValues instance for this LeafReaderstatic BinaryDocValues
DocValues. getBinary(LeafReader reader, java.lang.String field)
Returns BinaryDocValues for the field, orDocValues.emptyBinary()
if it has none.IndexSorter.DocComparator
IndexSorter.DoubleSorter. getDocComparator(LeafReader reader, int maxDoc)
IndexSorter.DocComparator
IndexSorter.FloatSorter. getDocComparator(LeafReader reader, int maxDoc)
IndexSorter.DocComparator
IndexSorter. getDocComparator(LeafReader reader, int maxDoc)
Get a comparator that determines the sort order of docs within a single Reader.IndexSorter.DocComparator
IndexSorter.IntSorter. getDocComparator(LeafReader reader, int maxDoc)
IndexSorter.DocComparator
IndexSorter.LongSorter. getDocComparator(LeafReader reader, int maxDoc)
IndexSorter.DocComparator
IndexSorter.StringSorter. getDocComparator(LeafReader reader, int maxDoc)
static NumericDocValues
DocValues. getNumeric(LeafReader reader, java.lang.String field)
Returns NumericDocValues for the field, orDocValues.emptyNumeric()
if it has none.static SortedDocValues
DocValues. getSorted(LeafReader reader, java.lang.String field)
Returns SortedDocValues for the field, orDocValues.emptySorted()
if it has none.static SortedNumericDocValues
DocValues. getSortedNumeric(LeafReader reader, java.lang.String field)
Returns SortedNumericDocValues for the field, orDocValues.emptySortedNumeric()
if it has none.static SortedSetDocValues
DocValues. getSortedSet(LeafReader reader, java.lang.String field)
Returns SortedSetDocValues for the field, orDocValues.emptySortedSet()
if it has none.private static PointsReader
SlowCodecReaderWrapper. pointValuesToReader(LeafReader reader)
private static DocValuesProducer
SlowCodecReaderWrapper. readerToDocValuesProducer(LeafReader reader)
private static FieldsProducer
SlowCodecReaderWrapper. readerToFieldsProducer(LeafReader reader)
private static NormsProducer
SlowCodecReaderWrapper. readerToNormsProducer(LeafReader reader)
private static StoredFieldsReader
SlowCodecReaderWrapper. readerToStoredFieldsReader(LeafReader reader)
private static TermVectorsReader
SlowCodecReaderWrapper. readerToTermVectorsReader(LeafReader reader)
(package private) Sorter.DocMap
Sorter. sort(LeafReader reader)
Returns a mapping from the old document ID to its new location in the sorted index.static LeafReader
FilterLeafReader. unwrap(LeafReader reader)
Get the wrapped instance byreader
as long as this reader is an instance ofFilterLeafReader
.void
IndexWriter.IndexReaderWarmer. warm(LeafReader reader)
Invoked on theLeafReader
for the newly merged segment, before that segment is made visible to near-real-time readers.void
SimpleMergedSegmentWarmer. warm(LeafReader reader)
LeafReader
ExitableDirectoryReader.ExitableSubReaderWrapper. wrap(LeafReader reader)
abstract LeafReader
FilterDirectoryReader.SubReaderWrapper. wrap(LeafReader reader)
Wrap one of the parent DirectoryReader's subreadersstatic CodecReader
SlowCodecReaderWrapper. wrap(LeafReader reader)
Returns aCodecReader
view of reader.LeafReader
SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper. wrap(LeafReader reader)
(package private) static LeafReader
SoftDeletesDirectoryReaderWrapper. wrap(LeafReader reader, java.lang.String field)
(package private) static LeafReader
SortingLeafReader. wrap(LeafReader reader, Sorter.DocMap docMap)
Expert: same asSortingLeafReader.wrap(org.apache.lucene.index.LeafReader, Sort)
but operates directly on aSorter.DocMap
.static LeafReader
SortingLeafReader. wrap(LeafReader reader, Sort sort)
Return a sorted view ofreader
according to the order defined bysort
.Method parameters in org.apache.lucene.index with type arguments of type LeafReader Modifier and Type Method Description IndexSorter.ComparableProvider[]
IndexSorter.DoubleSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
IndexSorter.ComparableProvider[]
IndexSorter.FloatSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
IndexSorter.ComparableProvider[]
IndexSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
Get an array ofIndexSorter.ComparableProvider
, one per segment, for merge sorting documents in different segmentsIndexSorter.ComparableProvider[]
IndexSorter.IntSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
IndexSorter.ComparableProvider[]
IndexSorter.LongSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
IndexSorter.ComparableProvider[]
IndexSorter.StringSorter. getComparableProviders(java.util.List<? extends LeafReader> readers)
static DirectoryReader
StandardDirectoryReader. open(Directory directory, SegmentInfos infos, java.util.List<? extends LeafReader> oldReaders)
This constructor is only used forStandardDirectoryReader.doOpenIfChanged(SegmentInfos)
, as well as NRT replication.protected LeafReader[]
FilterDirectoryReader.SubReaderWrapper. wrap(java.util.List<? extends LeafReader> readers)
Wraps a list of LeafReadersprotected LeafReader[]
SoftDeletesDirectoryReaderWrapper.SoftDeletesSubReaderWrapper. wrap(java.util.List<? extends LeafReader> readers)
Constructors in org.apache.lucene.index with parameters of type LeafReader Constructor Description DirectoryReader(Directory directory, LeafReader[] segmentReaders)
Expert: Constructs aDirectoryReader
on the given subReaders.ExitableFilterAtomicReader(LeafReader in, QueryTimeout queryTimeout)
ConstructorFilterLeafReader(LeafReader in)
Construct a FilterLeafReader based on the specified base reader.LeafReaderContext(CompositeReaderContext parent, LeafReader reader, int ord, int docBase, int leafOrd, int leafDocBase)
Creates a newLeafReaderContext
LeafReaderContext(LeafReader leafReader)
ParallelLeafReader(boolean closeSubReaders, LeafReader... readers)
Create a ParallelLeafReader based on the provided readers.ParallelLeafReader(boolean closeSubReaders, LeafReader[] readers, LeafReader[] storedFieldsReaders)
Expert: create a ParallelLeafReader based on the provided readers and storedFieldReaders; when a document is loaded, only storedFieldsReaders will be used.ParallelLeafReader(LeafReader... readers)
Create a ParallelLeafReader based on the provided readers; auto-closes the given readers onIndexReader.close()
.SoftDeletesFilterLeafReader(LeafReader reader, FixedBitSet bits, int numDocs)
SortingLeafReader(LeafReader in, Sorter.DocMap docMap)
StandardDirectoryReader(Directory directory, LeafReader[] readers, IndexWriter writer, SegmentInfos sis, boolean applyAllDeletes, boolean writeAllDeletes)
called only from static open() methodsTermDocsIterator(LeafReader reader, boolean sortedTerms)
Constructor parameters in org.apache.lucene.index with type arguments of type LeafReader Constructor Description SoftDeletesSubReaderWrapper(java.util.Map<IndexReader.CacheKey,LeafReader> oldReadersCache, java.lang.String field)
-
Uses of LeafReader in org.apache.lucene.index.memory
Subclasses of LeafReader in org.apache.lucene.index.memory Modifier and Type Class Description private class
MemoryIndex.MemoryIndexReader
Search support for Lucene framework integration; implements all methods required by the Lucene IndexReader contracts. -
Uses of LeafReader in org.apache.lucene.monitor
Fields in org.apache.lucene.monitor declared as LeafReader Modifier and Type Field Description private LeafReader
DocumentBatch.MultiDocumentBatch. reader
private LeafReader
DocumentBatch.SingletonDocumentBatch. reader
Methods in org.apache.lucene.monitor that return LeafReader Modifier and Type Method Description private LeafReader
DocumentBatch.MultiDocumentBatch. build(IndexWriter writer, Document... docs)
LeafReader
DocumentBatch.MultiDocumentBatch. get()
LeafReader
DocumentBatch.SingletonDocumentBatch. get()
Methods in org.apache.lucene.monitor with parameters of type LeafReader Modifier and Type Method Description private Query
TermFilteredPresearcher. buildFilterClause(LeafReader reader, java.lang.String field)
private Query
TermFilteredPresearcher. buildFilterFields(LeafReader reader)
abstract Query
Presearcher. buildQuery(LeafReader reader, java.util.function.BiPredicate<java.lang.String,BytesRef> termAcceptor)
Build a query for a Monitor's queryindex from a LeafReader over a set of documents to monitor.Query
TermFilteredPresearcher. buildQuery(LeafReader reader, java.util.function.BiPredicate<java.lang.String,BytesRef> termAcceptor)
-
Uses of LeafReader in org.apache.lucene.search
Methods in org.apache.lucene.search with parameters of type LeafReader Modifier and Type Method Description static DocIdSetIterator
DocValuesFieldExistsQuery. getDocValuesDocIdSetIterator(java.lang.String field, LeafReader reader)
Returns aDocIdSetIterator
from the given field or null if the field doesn't exist in the reader or if the reader has no doc values for the field.private NumericDocValues
SortedNumericSortField. getValue(LeafReader reader)
private SortedDocValues
SortedSetSortField. getValues(LeafReader reader)
private static boolean
PhraseQuery. termNotInReader(LeafReader reader, Term term)
private boolean
TermQuery.TermWeight. termNotInReader(LeafReader reader, Term term)
Constructors in org.apache.lucene.search with parameters of type LeafReader Constructor Description LeafSimScorer(Similarity.SimScorer scorer, LeafReader reader, java.lang.String field, boolean needsScores)
Sole constructor: Score documents ofreader
withscorer
.MultiNormsLeafSimScorer(Similarity.SimScorer scorer, LeafReader reader, java.util.Collection<BM25FQuery.FieldAndWeight> normFields, boolean needsScores)
Sole constructor: Score documents ofreader
withscorer
. -
Uses of LeafReader in org.apache.lucene.search.highlight
Subclasses of LeafReader in org.apache.lucene.search.highlight Modifier and Type Class Description class
TermVectorLeafReader
Wraps a Terms with aLeafReader
, typically from term vectors.(package private) static class
WeightedSpanTermExtractor.DelegatingLeafReader
Fields in org.apache.lucene.search.highlight declared as LeafReader Modifier and Type Field Description private LeafReader
WeightedSpanTermExtractor. internalReader
Constructors in org.apache.lucene.search.highlight with parameters of type LeafReader Constructor Description DelegatingLeafReader(LeafReader in)
-
Uses of LeafReader in org.apache.lucene.search.join
Methods in org.apache.lucene.search.join with parameters of type LeafReader Modifier and Type Method Description R
DocValuesTermsCollector.Function. apply(LeafReader t)
-
Uses of LeafReader in org.apache.lucene.search.suggest.document
Fields in org.apache.lucene.search.suggest.document declared as LeafReader Modifier and Type Field Description (package private) LeafReader
CompletionScorer. reader
Constructors in org.apache.lucene.search.suggest.document with parameters of type LeafReader Constructor Description CompletionScorer(CompletionWeight weight, NRTSuggester suggester, LeafReader reader, Bits filterDocs, boolean filtered, Automaton automaton)
Creates a scorer for a field-specificsuggester
scoped byacceptDocs
-
Uses of LeafReader in org.apache.lucene.search.uhighlight
Subclasses of LeafReader in org.apache.lucene.search.uhighlight Modifier and Type Class Description class
OverlaySingleDocTermsLeafReader
Overlays a 2nd LeafReader for the terms of one field, otherwise the primary reader is consulted.private static class
PhraseHelper.SingleFieldWithOffsetsFilterLeafReader
Needed to support the ability to highlight a query irrespective of the field a query refers to (aka requireFieldMatch=false).(package private) class
TermVectorFilteredLeafReader
A filtered LeafReader that only includes the terms that are also in a provided set of terms.private static class
UnifiedHighlighter.TermVectorReusingLeafReader
Wraps an IndexReader that remembers/caches the last call toIndexReader.getTermVectors(int)
so that if the next call has the same ID, then it is reused.Fields in org.apache.lucene.search.uhighlight declared as LeafReader Modifier and Type Field Description private LeafReader
OverlaySingleDocTermsLeafReader. in2
private LeafReader
MemoryIndexOffsetStrategy. memIndexLeafReader
Methods in org.apache.lucene.search.uhighlight with parameters of type LeafReader Modifier and Type Method Description protected OffsetsEnum
FieldOffsetStrategy. createOffsetsEnumFromReader(LeafReader leafReader, int doc)
void
PhraseHelper. createOffsetsEnumsForSpans(LeafReader leafReader, int docId, java.util.List<OffsetsEnum> results)
Given the internal SpanQueries, produce a number of OffsetsEnum into theresults
param.protected void
FieldOffsetStrategy. createOffsetsEnumsWeightMatcher(LeafReader _leafReader, int docId, java.util.List<OffsetsEnum> results)
abstract OffsetsEnum
FieldOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
The primary method -- return offsets for highlightable words in the specified document.OffsetsEnum
MemoryIndexOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
OffsetsEnum
NoOpOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
OffsetsEnum
PostingsOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
OffsetsEnum
PostingsWithTermVectorsOffsetStrategy. getOffsetsEnum(LeafReader leafReader, int docId, java.lang.String content)
OffsetsEnum
TermVectorOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
OffsetsEnum
TokenStreamOffsetStrategy. getOffsetsEnum(LeafReader reader, int docId, java.lang.String content)
java.lang.Object
FieldHighlighter. highlightFieldForDoc(LeafReader reader, int docId, java.lang.String content)
The primary method -- highlight this doc, assuming a specific field and given this content.Constructors in org.apache.lucene.search.uhighlight with parameters of type LeafReader Constructor Description OverlaySingleDocTermsLeafReader(LeafReader in, LeafReader in2, java.lang.String in2Field, int in2TargetDocId)
SingleFieldWithOffsetsFilterLeafReader(LeafReader in, java.lang.String fieldName)
TermVectorFilteredLeafReader(LeafReader baseLeafReader, Terms filterTerms, java.lang.String fieldFilter)
Construct a FilterLeafReader based on the specified base reader.TermVectorReusingLeafReader(LeafReader in)
-