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

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

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

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


Enum Constant Summary
COLUMN_FAMILIES_TO_FETCH
          The column families to fetch.
COLUMNS_TO_FETCH
          The columns in the families to fetch.
HIGHLIGHT_OPTIONS
          The HighlightOptions object controls how the data is highlighted.
LOCATION_ID
          WARNING: This is an internal only attribute and is not intended for use by clients.
MAX_RECORDS_TO_FETCH
          Only valid for Row fetches, the number of records to fetch.
ORDER_OF_FAMILIES_TO_FETCH
          Can be null, if provided the provided family order will be the order in which the families are returned.
RECORD_ID
          The record id of the Record to be fetched, not to be used with location id.
RECORD_ONLY
          Fetch the Record only, not the entire Row.
ROW_ID
          The row id of the Row to be fetched, not to be used with location id.
START_RECORD
          Only valid for Row fetches, the record in the row to start fetching.
 
Method Summary
static Selector._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static Selector._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static Selector._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 Selector._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Selector._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

RECORD_ONLY

public static final Selector._Fields RECORD_ONLY
Fetch the Record only, not the entire Row.


LOCATION_ID

public static final Selector._Fields LOCATION_ID
WARNING: This is an internal only attribute and is not intended for use by clients. The location id of the Record or Row to be fetched.


ROW_ID

public static final Selector._Fields ROW_ID
The row id of the Row to be fetched, not to be used with location id.


RECORD_ID

public static final Selector._Fields RECORD_ID
The record id of the Record to be fetched, not to be used with location id. However the row id needs to be provided to locate the correct Row with the requested Record.


COLUMN_FAMILIES_TO_FETCH

public static final Selector._Fields COLUMN_FAMILIES_TO_FETCH
The column families to fetch. If null, fetch all. If empty, fetch none.


COLUMNS_TO_FETCH

public static final Selector._Fields COLUMNS_TO_FETCH
The columns in the families to fetch. If null, fetch all. If empty, fetch none.


START_RECORD

public static final Selector._Fields START_RECORD
Only valid for Row fetches, the record in the row to start fetching. If the row contains 1000 records and you want the first 100, then this value is 0. If you want records 300-400 then this value would be 300. If startRecord is beyond the end of the row, the row will be null in the FetchResult. Used in conjunction with maxRecordsToFetch.


MAX_RECORDS_TO_FETCH

public static final Selector._Fields MAX_RECORDS_TO_FETCH
Only valid for Row fetches, the number of records to fetch. If the row contains 1000 records and you want the first 100, then this value is 100. If you want records 300-400 then this value would be 100. Used in conjunction with startRecord. By default this will fetch the first 1000 records of the row.


HIGHLIGHT_OPTIONS

public static final Selector._Fields HIGHLIGHT_OPTIONS
The HighlightOptions object controls how the data is highlighted. If null no highlighting will occur.


ORDER_OF_FAMILIES_TO_FETCH

public static final Selector._Fields ORDER_OF_FAMILIES_TO_FETCH
Can be null, if provided the provided family order will be the order in which the families are returned.

Method Detail

values

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


findByThriftIdOrThrow

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


findByName

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