Field Detail

• EMPTY_DOCIDSET

  public static final DocIdSet EMPTY_DOCIDSET

  An empty DocIdSet instance for easy use, e.g. in Filters that hit no documents.

Constructor Detail

• DocIdSet

  public DocIdSet()

Method Detail

• iterator

  public abstract DocIdSetIterator iterator()
                                     throws IOException

  Provides a DocIdSetIterator to access the set. This implementation can return null or EMPTY_DOCIDSET.iterator() if there are no docs that match.

  Throws:

  IOException

• isCacheable

  public boolean isCacheable()

  This method is a hint for CachingWrapperFilter, if this DocIdSet should be cached without copying it into a BitSet. 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.