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

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

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

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


Enum Constant Summary
COLUMN_NAME
          Required.
FAMILY
          Required.
FIELD_LESS_INDEXED
          If this column should be searchable without having to specify the name of the column in the query.
FIELD_TYPE
          The field type for the column.
PROPERTIES
          For any custom field types, you can pass in configuration properties.
SORTABLE
          This will attempt to enable sorting for this column, if the type does not support sorting then an exception will be thrown.
SUB_COLUMN_NAME
          If this column definition is for a sub column then provide the sub column name.
 
Method Summary
static ColumnDefinition._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static ColumnDefinition._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static ColumnDefinition._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 ColumnDefinition._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ColumnDefinition._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

FAMILY

public static final ColumnDefinition._Fields FAMILY
Required. The family that this column exists within.


COLUMN_NAME

public static final ColumnDefinition._Fields COLUMN_NAME
Required. The column name.


SUB_COLUMN_NAME

public static final ColumnDefinition._Fields SUB_COLUMN_NAME
If this column definition is for a sub column then provide the sub column name. Otherwise leave this field null.


FIELD_LESS_INDEXED

public static final ColumnDefinition._Fields FIELD_LESS_INDEXED
If this column should be searchable without having to specify the name of the column in the query. NOTE: This will index the column as a full text field in a default field, so that means it's going to be indexed twice.


FIELD_TYPE

public static final ColumnDefinition._Fields FIELD_TYPE
The field type for the column. The built in types are:


PROPERTIES

public static final ColumnDefinition._Fields PROPERTIES
For any custom field types, you can pass in configuration properties.


SORTABLE

public static final ColumnDefinition._Fields SORTABLE
This will attempt to enable sorting for this column, if the type does not support sorting then an exception will be thrown.

Method Detail

values

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


findByThriftIdOrThrow

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


findByName

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