Module org.elasticsearch.server
Package org.elasticsearch.index.codec.bloomfilter

Interface BloomFilter

public interface BloomFilter

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final BloomFilter
    NO_FILTER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    mayContainValue(String field, org.apache.lucene.util.BytesRef term)
    Tests whether the given term may exist in the specified field.
    double
    saturation()
    Returns the saturation of the bloom filter as a value in [0, 1], i.e.
    long
    sizeInBytes()
    Returns the size in bytes of the bloom filter data on disk.

  • Field Details

  • Method Details

    • mayContainValue

      boolean mayContainValue(String field, org.apache.lucene.util.BytesRef term) throws IOException
      Tests whether the given term may exist in the specified field.
      Parameters:
      field - the field name to check
      term - the term to test for membership
      Returns:
      true if term may be present, false if definitely absent
      Throws:
      IOException

    • sizeInBytes

      long sizeInBytes()
      Returns the size in bytes of the bloom filter data on disk.

    • saturation

      double saturation() throws IOException
      Returns the saturation of the bloom filter as a value in [0, 1], i.e. the fraction of bits that are set. Higher saturation means a higher false positive rate.
      Throws:
      IOException