Package org.apache.lucene.index

Class FilterAtomicReader.FilterFields

  • All Implemented Interfaces:
    java.lang.Iterable<java.lang.String>
    Enclosing class:
    FilterAtomicReader
    public static class FilterAtomicReader.FilterFields
extends Fields
    Base class for filtering Fields implementations.

    • Constructor Summary

      Constructors 
      Constructor Description
      FilterFields​(Fields in)
      Creates a new FilterFields.

    • 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

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • FilterFields

        public FilterFields​(Fields in)
        Creates a new FilterFields.
        Parameters:
        in - the underlying Fields instance.

    • 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