org.apache.solr.search
Class EarlyTerminatingCollectorException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.apache.solr.search.EarlyTerminatingCollectorException

All Implemented Interfaces:

Serializable

public class EarlyTerminatingCollectorException
extends RuntimeException

Thrown by EarlyTerminatingCollector when the maximum to abort the scoring / collection process early, when the specified maximum number of documents were collected.

See Also:

Serialized Form

Constructor Summary

EarlyTerminatingCollectorException(int numberCollected, int numberScanned)

Method Summary

int	getNumberCollected() The number of documents collected that resulted in early termination
int	getNumberScanned() The total number of documents in the index that were "scanned" by the index when collecting the getNumberCollected() documents that triggered this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EarlyTerminatingCollectorException

public EarlyTerminatingCollectorException(int numberCollected,
                                          int numberScanned)

Method Detail

getNumberScanned

public int getNumberScanned()

The total number of documents in the index that were "scanned" by the index when collecting the getNumberCollected() documents that triggered this exception.

This number represents the sum of:

• The total number of documents in all AtomicReaders that were fully exhausted during collection
• The id of the last doc collected in the last AtomicReader consulted during collection.

getNumberCollected

public int getNumberCollected()

The number of documents collected that resulted in early termination