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

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

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

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


Enum Constant Summary
MINIMUM_NUMBER_OF_BLUR_RESULTS
          The minimum number of results before no longer processing the facet.
QUERY_STR
          The facet query.
 
Method Summary
static Facet._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static Facet._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static Facet._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 Facet._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Facet._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_STR

public static final Facet._Fields QUERY_STR
The facet query.


MINIMUM_NUMBER_OF_BLUR_RESULTS

public static final Facet._Fields MINIMUM_NUMBER_OF_BLUR_RESULTS
The minimum number of results before no longer processing the facet. This is a good way to decrease the strain on the system while using many facets. For example if you set this attribute to 1000, then the shard server will stop processing the facet at the 1000 mark. However because this is processed at the shard server level the controller will likely return more than the minimum because it sums the answers from the shard servers.

Method Detail

values

public static Facet._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 (Facet._Fields c : Facet._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 Facet._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 Facet._Fields findByThriftId(int fieldId)
Find the _Fields constant that matches fieldId, or null if its not found.


findByThriftIdOrThrow

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


findByName

public static Facet._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.