[LUCENE-5441] Decouple DocIdSet from OpenBitSet and FixedBitSet

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.6.1
• Fix Version/s: 5.0, 6.0
• Component/s: core/other
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Uwe Schindler
• Created: 09/Feb/14 15:54
• Updated: 28/Aug/22 14:00
• Resolved: 22/Oct/14 15:25

Description

Back from the times of Lucene 2.4 when DocIdSet was introduced, we somehow kept the stupid "filters can return a BitSet directly" in the code. So lots of Filters return just FixedBitSet, because this is the superclass (ideally interface) of FixedBitSet.

We should decouple that and not implement that abstract interface directly by FixedBitSet. This leads to bugs e.g. in BlockJoin, because it used Filters in a wrong way, just because it was always returning Bitsets. But some filters actually don't do this.

I propose to let FixedBitSet (only in trunk, because that a major backwards break) just have a method asDocIdSet(), that returns an anonymous instance of DocIdSet: bits() returns the FixedBitSet itsself, iterator() returns a new Iterator (like it always did) and the cost/cacheable methods return static values.

Filters in trunk would need to be changed like that:

FixedBitSet bits = ....
...
return bits;

gets:

FixedBitSet bits = ....
...
return bits.asDocIdSet();

As this methods returns an anonymous DocIdSet, calling code can no longer rely or check if the implementation behind is a FixedBitSet.

Issue Links

• depends upon: LUCENE-5440 Add LongFixedBitSet and replace usage of OpenBitSet