Lucene.Net.Search.DocIdSet Class Reference

A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide access to the set. More...

Inherited by Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet, Lucene.Net.Search.FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet, Lucene.Net.Search.FilteredDocIdSet, Lucene.Net.Search.QueryWrapperFilter.AnonymousClassDocIdSet, and Lucene.Net.Spatial.Util.FixedBitSet.

Classes
class	AnonymousClassDocIdSet

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

Static Public Attributes
static readonly DocIdSet	EMPTY_DOCIDSET
	An empty DocIdSet instance for easy use, e.g. in Filters that hit no documents.

Properties
virtual bool	IsCacheable [get]
	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.

Detailed Description

A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide access to the set.

Definition at line 27 of file DocIdSet.cs.

Member Function Documentation

abstract DocIdSetIterator Lucene.Net.Search.DocIdSet.Iterator ( )

pure virtual

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

Implemented in Lucene.Net.Spatial.Util.FixedBitSet, Lucene.Net.Search.FilteredDocIdSet, and Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet.

Member Data Documentation

readonly DocIdSet Lucene.Net.Search.DocIdSet.EMPTY_DOCIDSET

static

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

Definition at line 87 of file DocIdSet.cs.

Property Documentation

virtual bool Lucene.Net.Search.DocIdSet.IsCacheable

get

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.

Definition at line 103 of file DocIdSet.cs.

---

The documentation for this class was generated from the following file:

• core/Search/DocIdSet.cs