Home » lucene-3.0.1-src » org.apache » lucene » search » [javadoc | source]
org.apache.lucene.search
abstract public class: DocIdSet [javadoc | source]
java.lang.Object
   org.apache.lucene.search.DocIdSet

Direct Known Subclasses:
    OpenBitSet, OpenBitSetDISI, FilteredDocIdSet, SortedVIntList, FieldCacheDocIdSet, DocIdBitSet, FieldCacheTermsFilterDocIdSet

A DocIdSet contains a set of doc ids. Implementing classes must only implement #iterator to provide access to the set.
Field Summary
public static final  DocIdSet EMPTY_DOCIDSET    An empty {@code DocIdSet} instance for easy use, e.g. in Filters that hit no documents. 
Method from org.apache.lucene.search.DocIdSet Summary:
isCacheable,   iterator
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.DocIdSet Detail:
 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.
 abstract public DocIdSetIterator iterator() throws IOException
    Provides a DocIdSetIterator to access the set. This implementation can return null or {@linkplain #EMPTY_DOCIDSET}.iterator() if there are no docs that match.