Package eu.clarin.sru.server

Enum SRUResultCountPrecision

java.lang.Object

java.lang.Enum<SRUResultCountPrecision>

eu.clarin.sru.server.SRUResultCountPrecision

All Implemented Interfaces:

Serializable, Comparable<SRUResultCountPrecision>

public enum SRUResultCountPrecision
extends Enum<SRUResultCountPrecision>

(SRU 2.0) Indicate the accuracy of the result count reported by total number of records that matched the query.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENT	The value supplied is an estimate of the count at the time the response was sent, however the result set may continue to grow.
ESTIMATE	The server does not know the result set count, but offers an estimate.
EXACT	The server guarantees that the reported number of records is accurate.
MAXIMUM	The value supplied is an estimate of the maximum possible count that the result set will attain.
MINIMUM	The server does not know the result count but guarantees that it is at least this large.
UNKNOWN	The server has no idea what the result count is, and does not want to venture an estimate.

Method Summary

Modifier and Type	Method	Description
static SRUResultCountPrecision	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SRUResultCountPrecision[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXACT

public static final SRUResultCountPrecision EXACT

The server guarantees that the reported number of records is accurate.

UNKNOWN

public static final SRUResultCountPrecision UNKNOWN

The server has no idea what the result count is, and does not want to venture an estimate.

ESTIMATE

public static final SRUResultCountPrecision ESTIMATE

The server does not know the result set count, but offers an estimate.

MAXIMUM

public static final SRUResultCountPrecision MAXIMUM

The value supplied is an estimate of the maximum possible count that the result set will attain.

MINIMUM

public static final SRUResultCountPrecision MINIMUM

The server does not know the result count but guarantees that it is at least this large.

CURRENT

public static final SRUResultCountPrecision CURRENT

The value supplied is an estimate of the count at the time the response was sent, however the result set may continue to grow.

Method Detail

values

public static SRUResultCountPrecision[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SRUResultCountPrecision c : SRUResultCountPrecision.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SRUResultCountPrecision valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null