Class OverlaySingleDocTermsLeafReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.FilterLeafReader
-
- org.apache.lucene.search.uhighlight.OverlaySingleDocTermsLeafReader
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class OverlaySingleDocTermsLeafReader extends FilterLeafReader
Overlays a 2nd LeafReader for the terms of one field, otherwise the primary reader is consulted. The 2nd reader is assumed to have one document of 0 and we remap it to a target doc ID.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.FilterLeafReader
FilterLeafReader.FilterFields, FilterLeafReader.FilterPostingsEnum, FilterLeafReader.FilterTerms, FilterLeafReader.FilterTermsEnum
-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
-
Field Summary
Fields Modifier and Type Field Description private LeafReader
in2
private java.lang.String
in2Field
private int
in2TargetDocId
-
Fields inherited from class org.apache.lucene.index.FilterLeafReader
in
-
-
Constructor Summary
Constructors Constructor Description OverlaySingleDocTermsLeafReader(LeafReader in, LeafReader in2, java.lang.String in2Field, int in2TargetDocId)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IndexReader.CacheHelper
getCoreCacheHelper()
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions.IndexReader.CacheHelper
getReaderCacheHelper()
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this reader.Terms
terms(java.lang.String field)
Returns theTerms
index for this field, or null if it has none.-
Methods inherited from class org.apache.lucene.index.FilterLeafReader
checkIntegrity, doClose, document, getBinaryDocValues, getDelegate, getFieldInfos, getLiveDocs, getMetaData, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, getVectorValues, maxDoc, numDocs, searchNearestVectors, toString, unwrap
-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
-
-
-
Field Detail
-
in2
private final LeafReader in2
-
in2Field
private final java.lang.String in2Field
-
in2TargetDocId
private final int in2TargetDocId
-
-
Constructor Detail
-
OverlaySingleDocTermsLeafReader
public OverlaySingleDocTermsLeafReader(LeafReader in, LeafReader in2, java.lang.String in2Field, int in2TargetDocId)
-
-
Method Detail
-
terms
public Terms terms(java.lang.String field) throws java.io.IOException
Description copied from class:LeafReader
Returns theTerms
index for this field, or null if it has none.- Overrides:
terms
in classFilterLeafReader
- Throws:
java.io.IOException
-
getCoreCacheHelper
public IndexReader.CacheHelper getCoreCacheHelper()
Description copied from class:LeafReader
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions. Two readers that have the same data but different sets of deleted documents or doc values updates may be considered equal. Consider usingIndexReader.getReaderCacheHelper()
if you need deletions or dv updates to be taken into account.A return value of
null
indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped leaf reader.- Specified by:
getCoreCacheHelper
in classLeafReader
-
getReaderCacheHelper
public IndexReader.CacheHelper getReaderCacheHelper()
Description copied from class:IndexReader
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this reader. Two readers that have different data or different sets of deleted documents will be considered different.A return value of
null
indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped reader.- Specified by:
getReaderCacheHelper
in classIndexReader
-
-