Class DocIdSet

    • Constructor Detail

      • DocIdSet

        public DocIdSet()
    • Method Detail

      • bits

        public Bits bits()
                  throws IOException
        Optionally provides a Bits interface for random access to matching documents.
        null, if this DocIdSet does not support random access. In contrast to iterator(), a return value of null does not imply that no documents match the filter! The default implementation does not provide random access, so you only need to implement this method if your DocIdSet can guarantee random access to every docid in O(1) time without external disk access (as Bits interface cannot throw IOException). This is generally true for bit sets like FixedBitSet, which return itself if they are used as DocIdSet.
      • isCacheable

        public boolean isCacheable()
        This method is a hint for CachingWrapperFilter, if this DocIdSet should be cached without copying it. The default is to return false. If you have an own DocIdSet implementation that does its iteration very effective and fast without doing disk I/O, override this method and return true.