Class TermVectorFilteredLeafReader

All Implemented Interfaces:
Closeable, 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.
  • Field Details

    • filterTerms

      private final Terms filterTerms
    • fieldFilter

      private final String fieldFilter
  • Constructor Details

    • TermVectorFilteredLeafReader

      TermVectorFilteredLeafReader(LeafReader baseLeafReader, Terms filterTerms, 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 Details

    • 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
    • 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