org.apache.blur.thrift.generated
Enum BlurQuery._Fields

java.lang.Object
  extended by java.lang.Enum<BlurQuery._Fields>
      extended by org.apache.blur.thrift.generated.BlurQuery._Fields
All Implemented Interfaces:
Serializable, Comparable<BlurQuery._Fields>, TFieldIdEnum
Enclosing class:
BlurQuery

public static enum BlurQuery._Fields
extends Enum<BlurQuery._Fields>
implements TFieldIdEnum

The set of fields this struct contains, along with convenience methods for finding and manipulating them.


Enum Constant Summary
CACHE_RESULT
          Enabled by default to cache this result.
FACETS
          A list of Facets to execute with the given query.
FETCH
          The number of fetched results, 10 by default.
MAX_QUERY_TIME
          The maximum amount of time the query should execute before timing out.
MINIMUM_NUMBER_OF_RESULTS
          The minimum number of results to find before returning.
QUERY
          The query information.
ROW_ID
          Optional optimization for record queries to run against a single row.
SELECTOR
          Selector is used to fetch data in the search results, if null only location ids will be fetched.
SORT_FIELDS
          The sortfields are applied in order to sort the results.
START
          The starting result position, 0 by default.
START_TIME
          Sets the start time, if 0 the controller sets the time.
USE_CACHE_IF_PRESENT
          Enabled by default to use a cached result if the query matches a previous run query with the configured amount of time.
USER_CONTEXT
          Sets a user context, only used for logging at this point.
UUID
          Sets the uuid of this query, this is normal set by the client so that the status of a running query can be found or the query can be canceled.
 
Method Summary
static BlurQuery._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static BlurQuery._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static BlurQuery._Fields findByThriftIdOrThrow(int fieldId)
          Find the _Fields constant that matches fieldId, throwing an exception if it is not found.
 String getFieldName()
          Get the field's name, exactly as in the IDL.
 short getThriftFieldId()
          Get the Thrift field id for the named field.
static BlurQuery._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static BlurQuery._Fields[] 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

QUERY

public static final BlurQuery._Fields QUERY
The query information.


FACETS

public static final BlurQuery._Fields FACETS
A list of Facets to execute with the given query.


SELECTOR

public static final BlurQuery._Fields SELECTOR
Selector is used to fetch data in the search results, if null only location ids will be fetched.


USE_CACHE_IF_PRESENT

public static final BlurQuery._Fields USE_CACHE_IF_PRESENT
Enabled by default to use a cached result if the query matches a previous run query with the configured amount of time.


START

public static final BlurQuery._Fields START
The starting result position, 0 by default.


FETCH

public static final BlurQuery._Fields FETCH
The number of fetched results, 10 by default.


MINIMUM_NUMBER_OF_RESULTS

public static final BlurQuery._Fields MINIMUM_NUMBER_OF_RESULTS
The minimum number of results to find before returning.


MAX_QUERY_TIME

public static final BlurQuery._Fields MAX_QUERY_TIME
The maximum amount of time the query should execute before timing out.


UUID

public static final BlurQuery._Fields UUID
Sets the uuid of this query, this is normal set by the client so that the status of a running query can be found or the query can be canceled.


USER_CONTEXT

public static final BlurQuery._Fields USER_CONTEXT
Sets a user context, only used for logging at this point.


CACHE_RESULT

public static final BlurQuery._Fields CACHE_RESULT
Enabled by default to cache this result. False would not cache the result.


START_TIME

public static final BlurQuery._Fields START_TIME
Sets the start time, if 0 the controller sets the time.


SORT_FIELDS

public static final BlurQuery._Fields SORT_FIELDS
The sortfields are applied in order to sort the results.


ROW_ID

public static final BlurQuery._Fields ROW_ID
Optional optimization for record queries to run against a single row. This will allow the query to be executed on one and only one shard in the cluster.

Method Detail

values

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

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

valueOf

public static BlurQuery._Fields 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

findByThriftId

public static BlurQuery._Fields findByThriftId(int fieldId)
Find the _Fields constant that matches fieldId, or null if its not found.


findByThriftIdOrThrow

public static BlurQuery._Fields findByThriftIdOrThrow(int fieldId)
Find the _Fields constant that matches fieldId, throwing an exception if it is not found.


findByName

public static BlurQuery._Fields findByName(String name)
Find the _Fields constant that matches name, or null if its not found.


getThriftFieldId

public short getThriftFieldId()
Description copied from interface: TFieldIdEnum
Get the Thrift field id for the named field.

Specified by:
getThriftFieldId in interface TFieldIdEnum

getFieldName

public String getFieldName()
Description copied from interface: TFieldIdEnum
Get the field's name, exactly as in the IDL.

Specified by:
getFieldName in interface TFieldIdEnum


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.