Module org.apache.lucene.highlighter
Package org.apache.lucene.search.uhighlight

Class PhraseHelper.SingleFieldWithOffsetsFilterLeafReader

java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.FilterLeafReader
org.apache.lucene.search.uhighlight.PhraseHelper.SingleFieldWithOffsetsFilterLeafReader
All Implemented Interfaces:
Closeable, AutoCloseable
Enclosing class:
PhraseHelper
private static final class PhraseHelper.SingleFieldWithOffsetsFilterLeafReader extends FilterLeafReader
Needed to support the ability to highlight a query irrespective of the field a query refers to (aka requireFieldMatch=false). This reader will just delegate every call to a single field in the wrapped LeafReader. This way we ensure that all queries going through this reader target the same field.

  • Field Details

    • fieldName

      final String fieldName

  • Constructor Details

    • SingleFieldWithOffsetsFilterLeafReader

      SingleFieldWithOffsetsFilterLeafReader(LeafReader in, String fieldName)

  • Method Details

    • 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(String field) throws 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:
      IOException

    • getNormValues

      public NumericDocValues getNormValues(String field) throws 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:
      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