Package org.apache.lucene.limit

These classes are used to limit the amount of "work" performed by a query.

See: Description

Class Summary

Class	Description
LimIndexReader	Wraps a normal IndexReader to limit the amount of work performed by a query.
LimTermDocs	Used by LimIndexReader to help enforce the work limit while processing a query.
LimTermPositions	Used by LimIndexReader to help enforce the work limit while processing a query.

Exception Summary

Exception	Description
ExcessiveWorkException	Thrown when the maximum amount of work for a query has been exceeded.
TermLimitException	Thrown when the maximum number of terms for a range or wildcard query has been exceeded.

Package org.apache.lucene.limit Description

These classes are used to limit the amount of "work" performed by a query. The mechanism is easy to use: simply wrap a Lucene IndexReader with a LimIndexReader instance. Every time a document or position is read from the index, a counter is incremented, and if it exceeds the limit specified to LimIndexReader, an ExcessiveWorkException will be thrown.