Class MultiFields

  • All Implemented Interfaces:
    java.lang.Iterable<java.lang.String>

    public final class MultiFields
    extends Fields
    Provides a single Fields term index view over an IndexReader. This is useful when you're interacting with an IndexReader implementation that consists of sequential sub-readers (eg DirectoryReader or MultiReader) and you must treat it as a LeafReader.

    NOTE: for composite readers, you'll get better performance by gathering the sub readers using IndexReader.getContext() to get the atomic leaves and then operate per-LeafReader, instead of using this class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Iterator<java.lang.String> iterator()
      Returns an iterator that will step through all fields names.
      int size()
      Returns the number of fields or -1 if the number of distinct field names is unknown.
      Terms terms​(java.lang.String field)
      Get the Terms for this field.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Field Detail

      • subs

        private final Fields[] subs
      • terms

        private final java.util.Map<java.lang.String,​Terms> terms
    • Constructor Detail

      • MultiFields

        public MultiFields​(Fields[] subs,
                           ReaderSlice[] subSlices)
        Sole constructor.
    • Method Detail

      • iterator

        public java.util.Iterator<java.lang.String> iterator()
        Description copied from class: Fields
        Returns an iterator that will step through all fields names. This will not return null.
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>
        Specified by:
        iterator in class Fields
      • terms

        public Terms terms​(java.lang.String field)
                    throws java.io.IOException
        Description copied from class: Fields
        Get the Terms for this field. This will return null if the field does not exist.
        Specified by:
        terms in class Fields
        Throws:
        java.io.IOException
      • size

        public int size()
        Description copied from class: Fields
        Returns the number of fields or -1 if the number of distinct field names is unknown. If >= 0, Fields.iterator() will return as many field names.
        Specified by:
        size in class Fields