com.neeve.query
Enum QueryEngine.BackgroundIndexingPolicy

java.lang.Object
  java.lang.Enum<QueryEngine.BackgroundIndexingPolicy>
      com.neeve.query.QueryEngine.BackgroundIndexingPolicy

All Implemented Interfaces:

Serializable, Comparable<QueryEngine.BackgroundIndexingPolicy>

Enclosing interface:

QueryEngine<ID,REC>

public static enum QueryEngine.BackgroundIndexingPolicy
extends Enum<QueryEngine.BackgroundIndexingPolicy>

Enumerates valid background indexing policies. The background indexing policy dictates whether or not queries wait for indexing to complete before performing a query. In some cases it can be faster to proceed with a table scan to find a sufficient number of results rather than waiting for indexes to be populated.

Enum Constant Summary

FLUSH_NEVER
This policy indicates that if an index is not fully built, it will be ignored when executing queries.

FLUSH_ON_CREATE
This policy dictates that indexes must be fully built at creation time.

FLUSH_ON_QUERY
This policy dictates that all indexes be fully built prior to executing any query.

FLUSH_ON_USE
This policy dictates that an index be flushed prior to its use.

Method Summary

static QueryEngine.BackgroundIndexingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryEngine.BackgroundIndexingPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLUSH_ON_CREATE

public static final QueryEngine.BackgroundIndexingPolicy FLUSH_ON_CREATE

This policy dictates that indexes must be fully built at creation time. The creation call will block until the index is created.

FLUSH_ON_QUERY

public static final QueryEngine.BackgroundIndexingPolicy FLUSH_ON_QUERY

This policy dictates that all indexes be fully built prior to executing any query.

FLUSH_ON_USE

public static final QueryEngine.BackgroundIndexingPolicy FLUSH_ON_USE

This policy dictates that an index be flushed prior to its use.

FLUSH_NEVER

public static final QueryEngine.BackgroundIndexingPolicy FLUSH_NEVER

This policy indicates that if an index is not fully built, it will be ignored when executing queries.

Method Detail

values

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

Returns:

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

valueOf

public static QueryEngine.BackgroundIndexingPolicy 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