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

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

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

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


Enum Constant Summary
QUERY
          A Lucene syntax based query.
RECORD_FILTER
          The Record filter (normal Lucene syntax), is a filter performed before the join to filter out Records from the results.
ROW_FILTER
          The Row filter (normal Lucene syntax), is a filter performed after the join to filter out entire Rows from the results.
ROW_QUERY
          If the Row query is on, meaning the query will be perform against all the Records (joining records in some cases) and the result will be Rows (groupings of Record).
SCORE_TYPE
          The scoring type, see the document on ScoreType for explanation of each score type.
 
Method Summary
static Query._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static Query._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static Query._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 Query._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Query._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 Query._Fields QUERY
A Lucene syntax based query.


ROW_QUERY

public static final Query._Fields ROW_QUERY
If the Row query is on, meaning the query will be perform against all the Records (joining records in some cases) and the result will be Rows (groupings of Record).


SCORE_TYPE

public static final Query._Fields SCORE_TYPE
The scoring type, see the document on ScoreType for explanation of each score type.

See Also:
ScoreType

ROW_FILTER

public static final Query._Fields ROW_FILTER
The Row filter (normal Lucene syntax), is a filter performed after the join to filter out entire Rows from the results. This field is ignored when rowQuery is false.


RECORD_FILTER

public static final Query._Fields RECORD_FILTER
The Record filter (normal Lucene syntax), is a filter performed before the join to filter out Records from the results.

Method Detail

values

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


findByThriftIdOrThrow

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


findByName

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