Class TimeLimitingCollector

Create a TimeLimitingCollector wrapper over another ICollector with a specified timeout.

Returns the global TimeLimitingCollector.TimerThread's Counter

Invoking this creates may create a new instance of TimeLimitingCollector.TimerThread iff the global TimeLimitingCollector.TimerThread has never been accessed before. The thread returned from this method is started on creation and will be alive unless you stop the TimeLimitingCollector.TimerThread via StopTimer().

Returns the global TimeLimitingCollector.TimerThread.

Invoking this creates may create a new instance of TimeLimitingCollector.TimerThread iff the global TimeLimitingCollector.TimerThread has never been accessed before. The thread returned from this method is started on creation and will be alive unless you stop the TimeLimitingCollector.TimerThread via StopTimer().

Checks if this time limited collector is greedy in collecting the last hit. A non greedy collector, upon a timeout, would throw a TimeLimitingCollector.TimeExceededException without allowing the wrapped collector to collect current doc. A greedy one would first allow the wrapped hit collector to collect current doc and only then throw a TimeLimitingCollector.TimeExceededException.

Calls Collect(Int32) on the decorated ICollector unless the allowed time has passed, in which case it throws an exception.

Syntactic sugar for SetBaseline(Int64) using Get() on the clock passed to the constructor.

Sets the baseline for this collector. By default the collectors baseline is initialized once the first reader is passed to the collector. To include operations executed in prior to the actual document collection set the baseline through this method in your prelude.

Example usage:

    // Counter is in the Lucene.Net.Util namespace
    Counter clock = Counter.NewCounter(true);
    long baseline = clock.Get();
    // ... prepare search
    TimeLimitingCollector collector = new TimeLimitingCollector(c, clock, numTicks);
    collector.SetBaseline(baseline);
    indexSearcher.Search(query, collector);

This is so the same timer can be used with a multi-phase search process such as grouping. We don't want to create a new TimeLimitingCollector for each phase because that would reset the timer for each phase. Once time is up subsequent phases need to timeout quickly.