[COLLECTIONS-854] Changes suggested to M1 release

• Type: Improvement
• Status: In Progress
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 4.5.0-M1
• Component/s: Bloomfilter
• Assignee: Claude Warren
• Reporter: Claude Warren
• Created: 01/May/24 05:52
• Updated: 23/Jun/24 07:51

Description

This is a list of items that we have agreed need to be changed for clarity of API.

see https://lists.apache.org/thread/4fds9094c06o4gp1r8pf0xx4l0jthhds

 

• Rename classes:
  • CellConsumer to CellPredicate
  • BitMap to BitMaps.
  • BitMapProducer to BitMapExtractor
  • BloomFilterProducer to BloomFilterExtractor
  • IndexProducer to IndexExtractor
  • CellProducer to CellExtractor

• Rename methods:
  • Extractor methods forEachX() to processXs(Predicate<X>)

• Be clear that extractors are like interruptible iterators with predicate tests acting as a switch to stop the iteration before the final item.
• Document the semantic nomenclature:
  • Bitmaps are arrays of bits not a BitMaps object.
  • Indexes are ints and not an instance of a Collection object.
  • Cells are pairs of ints representing an index and a value.  They are not Pair<> objects.
  • Extractors
    • are extractors of representations of Bloom filter enabled bits. 
    • iterate over logical collections of the object (Bitmap, Index, Cell) applying a predicate to do work and stop the iteration early if necessary. 
    • allow us to query the contents of the Bloom filter in an implementation agnostic way.

 

Issue Links

• links to: GitHub Pull Request #492