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

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

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

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


Enum Constant Summary
POST_TAG
          The post tag is the tag that marks the end of the highlighting.
PRE_TAG
          The pre tag is the tag that marks the beginning of the highlighting.
QUERY
          The original query is required if used in the Blur.fetchRow call.
 
Method Summary
static HighlightOptions._Fields findByName(String name)
          Find the _Fields constant that matches name, or null if its not found.
static HighlightOptions._Fields findByThriftId(int fieldId)
          Find the _Fields constant that matches fieldId, or null if its not found.
static HighlightOptions._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 HighlightOptions._Fields valueOf(String name)
          Returns the enum constant of this type with the specified name.
static HighlightOptions._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 HighlightOptions._Fields QUERY
The original query is required if used in the Blur.fetchRow call. If the highlightOptions is used in a call to Blur.query then the Query passed into the call via the BlurQuery will be used if this query is null. So that means if you use highlighting from the query call you can leave this attribute null and it will default to the normal behavior.


PRE_TAG

public static final HighlightOptions._Fields PRE_TAG
The pre tag is the tag that marks the beginning of the highlighting.


POST_TAG

public static final HighlightOptions._Fields POST_TAG
The post tag is the tag that marks the end of the highlighting.

Method Detail

values

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


findByThriftIdOrThrow

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


findByName

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