org.apache.lucene.search.highlight

Class WeightedSpanTermExtractor.DelegatingLeafReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.FilterLeafReader

org.apache.lucene.search.highlight.WeightedSpanTermExtractor.DelegatingLeafReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

WeightedSpanTermExtractor

static final class WeightedSpanTermExtractor.DelegatingLeafReader
extends FilterLeafReader

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 and Description
private static java.lang.String	FIELD_NAME

Fields inherited from class org.apache.lucene.index.FilterLeafReader

in

Constructor Summary

Constructors

Constructor and Description
DelegatingLeafReader(LeafReader in)

Method Summary

Modifier and Type	Method and Description
BinaryDocValues	getBinaryDocValues(java.lang.String field) Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field.
IndexReader.CacheHelper	getCoreCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this leaf regardless of deletions.
FieldInfos	getFieldInfos() Get the FieldInfos describing all fields in this reader.
NumericDocValues	getNormValues(java.lang.String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(java.lang.String field) Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field.
IndexReader.CacheHelper	getReaderCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader.
SortedDocValues	getSortedDocValues(java.lang.String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
Terms	terms(java.lang.String field) Returns the Terms index for this field, or null if it has none.

Methods inherited from class org.apache.lucene.index.FilterLeafReader

checkIntegrity, doClose, document, getDelegate, getLiveDocs, getMetaData, getPointValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, maxDoc, numDocs, 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, numDeletedDocs, registerParentReader, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIELD_NAME

private static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

DelegatingLeafReader

DelegatingLeafReader(LeafReader in)

Method Detail

getFieldInfos

public FieldInfos getFieldInfos()

Description copied from class: LeafReader

Get the FieldInfos describing all fields in this reader. Note: Implementations should cache the FieldInfos instance returned by this method such that subsequent calls to this method return the same instance.

Overrides:

getFieldInfos in class FilterLeafReader

terms

public Terms terms(java.lang.String field)
            throws java.io.IOException

Description copied from class: LeafReader

Returns the Terms index for this field, or null if it has none.

Overrides:

terms in class FilterLeafReader

Throws:

java.io.IOException

getNumericDocValues

public NumericDocValues getNumericDocValues(java.lang.String field)
                                     throws java.io.IOException

Description copied from class: LeafReader

Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getNumericDocValues in class FilterLeafReader

Throws:

java.io.IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getBinaryDocValues in class FilterLeafReader

Throws:

java.io.IOException

getSortedDocValues

public SortedDocValues getSortedDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedDocValues in class FilterLeafReader

Throws:

java.io.IOException

getNormValues

public NumericDocValues getNormValues(java.lang.String field)
                               throws java.io.IOException

Description copied from class: LeafReader

Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed. The returned instance should only be used by a single thread.

Overrides:

getNormValues in class FilterLeafReader

Throws:

java.io.IOException

getCoreCacheHelper

public IndexReader.CacheHelper getCoreCacheHelper()

Description copied from class: LeafReader

Optional method: Return a IndexReader.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 using IndexReader.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 class LeafReader

getReaderCacheHelper

public IndexReader.CacheHelper getReaderCacheHelper()

Description copied from class: IndexReader

Optional method: Return a IndexReader.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 class IndexReader