Class TermVectorFilteredLeafReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.LeafReader
-
- org.apache.lucene.index.FilterLeafReader
-
- org.apache.lucene.search.uhighlight.TermVectorFilteredLeafReader
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
final class TermVectorFilteredLeafReader extends FilterLeafReader
A filtered LeafReader that only includes the terms that are also in a provided set of terms. Certain methods may be unimplemented or cause large operations on the underlying reader and be slow.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
TermVectorFilteredLeafReader.TermsFilteredTerms
private static class
TermVectorFilteredLeafReader.TermVectorFilteredTermsEnum
-
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 java.lang.String
fieldFilter
private Terms
filterTerms
-
Fields inherited from class org.apache.lucene.index.FilterLeafReader
in
-
-
Constructor Summary
Constructors Constructor Description TermVectorFilteredLeafReader(LeafReader baseLeafReader, Terms filterTerms, java.lang.String fieldFilter)
Construct a FilterLeafReader based on the specified base reader.
-
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, getByteVectorValues, getDelegate, getFieldInfos, getFloatVectorValues, getLiveDocs, getMetaData, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, maxDoc, numDocs, searchNearestVectors, searchNearestVectors, storedFields, termVectors, toString, unwrap
-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, 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
-
filterTerms
private final Terms filterTerms
-
fieldFilter
private final java.lang.String fieldFilter
-
-
Constructor Detail
-
TermVectorFilteredLeafReader
TermVectorFilteredLeafReader(LeafReader baseLeafReader, Terms filterTerms, java.lang.String fieldFilter)
Construct a FilterLeafReader based on the specified base reader.Note that base reader is closed if this FilterLeafReader is closed.
- Parameters:
baseLeafReader
- full/original reader.filterTerms
- set of terms to filter by -- probably from a TermVector or MemoryIndex.fieldFilter
- the field to do this on
-
-
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
-
-