Package org.apache.solr.handler.component

Enum QueryElevationComponent.InitializationExceptionCause

java.lang.Object

java.lang.Enum<QueryElevationComponent.InitializationExceptionCause>

org.apache.solr.handler.component.QueryElevationComponent.InitializationExceptionCause

All Implemented Interfaces:

Serializable, Comparable<QueryElevationComponent.InitializationExceptionCause>

Enclosing class:

QueryElevationComponent

protected static enum QueryElevationComponent.InitializationExceptionCause
extends Enum<QueryElevationComponent.InitializationExceptionCause>

See Also:

QueryElevationComponent.handleInitializationException(Exception, InitializationExceptionCause)

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY_CONFIG_FILE	The elevation configuration file (e.g.
MISSING_CONFIG_FILE	The elevation configuration file (e.g.
MISSING_UNIQUE_KEY_FIELD	This component requires the schema to have a uniqueKeyField, which it does not have.
NO_CONFIG_FILE_DEFINED	Missing component parameter QueryElevationComponent.CONFIG_FILE - it has to define the path to the elevation configuration file (e.g.
OTHER	Unclassified exception cause.
UNKNOWN_FIELD_TYPE	The component parameter QueryElevationComponent.FIELD_TYPE defines an unknown field type.

Method Summary

Modifier and Type	Method	Description
static QueryElevationComponent.InitializationExceptionCause	valueOf(String name)	Returns the enum constant of this type with the specified name.
static QueryElevationComponent.InitializationExceptionCause[]	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

UNKNOWN_FIELD_TYPE

public static final QueryElevationComponent.InitializationExceptionCause UNKNOWN_FIELD_TYPE

The component parameter QueryElevationComponent.FIELD_TYPE defines an unknown field type.

MISSING_UNIQUE_KEY_FIELD

public static final QueryElevationComponent.InitializationExceptionCause MISSING_UNIQUE_KEY_FIELD

This component requires the schema to have a uniqueKeyField, which it does not have.

NO_CONFIG_FILE_DEFINED

public static final QueryElevationComponent.InitializationExceptionCause NO_CONFIG_FILE_DEFINED

Missing component parameter QueryElevationComponent.CONFIG_FILE - it has to define the path to the elevation configuration file (e.g. elevate.xml).

MISSING_CONFIG_FILE

public static final QueryElevationComponent.InitializationExceptionCause MISSING_CONFIG_FILE

The elevation configuration file (e.g. elevate.xml) cannot be found, or is defined in both conf/ and data/ directories.

EMPTY_CONFIG_FILE

public static final QueryElevationComponent.InitializationExceptionCause EMPTY_CONFIG_FILE

The elevation configuration file (e.g. elevate.xml) is empty.

OTHER

public static final QueryElevationComponent.InitializationExceptionCause OTHER

Unclassified exception cause.

Method Detail

values

public static QueryElevationComponent.InitializationExceptionCause[] 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 (QueryElevationComponent.InitializationExceptionCause c : QueryElevationComponent.InitializationExceptionCause.values())
    System.out.println(c);

Returns:

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

valueOf

public static QueryElevationComponent.InitializationExceptionCause 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