org.apache.blur.thrift.generated
Class HighlightOptions

java.lang.Object
  extended by org.apache.blur.thrift.generated.HighlightOptions
All Implemented Interfaces:
Serializable, Cloneable, Comparable<HighlightOptions>, TBase<HighlightOptions,HighlightOptions._Fields>

public class HighlightOptions
extends Object
implements TBase<HighlightOptions,HighlightOptions._Fields>, Serializable, Cloneable

The HighlightOptions controls how the data is fetched and returned.

See Also:
Serialized Form

Nested Class Summary
static class HighlightOptions._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static Map<HighlightOptions._Fields,FieldMetaData> metaDataMap
           
 String postTag
          The post tag is the tag that marks the end of the highlighting.
 String preTag
          The pre tag is the tag that marks the beginning of the highlighting.
 Query query
          The original query is required if used in the Blur.fetchRow call.
 
Constructor Summary
HighlightOptions()
           
HighlightOptions(HighlightOptions other)
          Performs a deep copy on other.
HighlightOptions(Query query, String preTag, String postTag)
           
 
Method Summary
 void clear()
          Return to the state of having just been initialized, as though you had just called the default constructor.
 int compareTo(HighlightOptions other)
           
 HighlightOptions deepCopy()
           
 boolean equals(HighlightOptions that)
           
 boolean equals(Object that)
           
 HighlightOptions._Fields fieldForId(int fieldId)
          Get the F instance that corresponds to fieldId.
 Object getFieldValue(HighlightOptions._Fields field)
          Get a field's value by field variable.
 String getPostTag()
          The post tag is the tag that marks the end of the highlighting.
 String getPreTag()
          The pre tag is the tag that marks the beginning of the highlighting.
 Query getQuery()
          The original query is required if used in the Blur.fetchRow call.
 int hashCode()
           
 boolean isSet(HighlightOptions._Fields field)
          Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
 boolean isSetPostTag()
          Returns true if field postTag is set (has been assigned a value) and false otherwise
 boolean isSetPreTag()
          Returns true if field preTag is set (has been assigned a value) and false otherwise
 boolean isSetQuery()
          Returns true if field query is set (has been assigned a value) and false otherwise
 void read(TProtocol iprot)
          Reads the TObject from the given input protocol.
 void setFieldValue(HighlightOptions._Fields field, Object value)
          Set a field's value by field variable.
 HighlightOptions setPostTag(String postTag)
          The post tag is the tag that marks the end of the highlighting.
 void setPostTagIsSet(boolean value)
           
 HighlightOptions setPreTag(String preTag)
          The pre tag is the tag that marks the beginning of the highlighting.
 void setPreTagIsSet(boolean value)
           
 HighlightOptions setQuery(Query query)
          The original query is required if used in the Blur.fetchRow call.
 void setQueryIsSet(boolean value)
           
 String toString()
           
 void unsetPostTag()
           
 void unsetPreTag()
           
 void unsetQuery()
           
 void validate()
           
 void write(TProtocol oprot)
          Writes the objects out to the protocol
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

query

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


preTag

public String preTag
The pre tag is the tag that marks the beginning of the highlighting.


postTag

public String postTag
The post tag is the tag that marks the end of the highlighting.


metaDataMap

public static final Map<HighlightOptions._Fields,FieldMetaData> metaDataMap
Constructor Detail

HighlightOptions

public HighlightOptions()

HighlightOptions

public HighlightOptions(Query query,
                        String preTag,
                        String postTag)

HighlightOptions

public HighlightOptions(HighlightOptions other)
Performs a deep copy on other.

Method Detail

deepCopy

public HighlightOptions deepCopy()
Specified by:
deepCopy in interface TBase<HighlightOptions,HighlightOptions._Fields>

clear

public void clear()
Description copied from interface: TBase
Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:
clear in interface TBase<HighlightOptions,HighlightOptions._Fields>

getQuery

public Query getQuery()
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.


setQuery

public HighlightOptions setQuery(Query 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.


unsetQuery

public void unsetQuery()

isSetQuery

public boolean isSetQuery()
Returns true if field query is set (has been assigned a value) and false otherwise


setQueryIsSet

public void setQueryIsSet(boolean value)

getPreTag

public String getPreTag()
The pre tag is the tag that marks the beginning of the highlighting.


setPreTag

public HighlightOptions setPreTag(String preTag)
The pre tag is the tag that marks the beginning of the highlighting.


unsetPreTag

public void unsetPreTag()

isSetPreTag

public boolean isSetPreTag()
Returns true if field preTag is set (has been assigned a value) and false otherwise


setPreTagIsSet

public void setPreTagIsSet(boolean value)

getPostTag

public String getPostTag()
The post tag is the tag that marks the end of the highlighting.


setPostTag

public HighlightOptions setPostTag(String postTag)
The post tag is the tag that marks the end of the highlighting.


unsetPostTag

public void unsetPostTag()

isSetPostTag

public boolean isSetPostTag()
Returns true if field postTag is set (has been assigned a value) and false otherwise


setPostTagIsSet

public void setPostTagIsSet(boolean value)

setFieldValue

public void setFieldValue(HighlightOptions._Fields field,
                          Object value)
Description copied from interface: TBase
Set a field's value by field variable. Primitive types must be "boxed" in the appropriate object wrapper type.

Specified by:
setFieldValue in interface TBase<HighlightOptions,HighlightOptions._Fields>

getFieldValue

public Object getFieldValue(HighlightOptions._Fields field)
Description copied from interface: TBase
Get a field's value by field variable. Primitive types will be wrapped in the appropriate "boxed" types.

Specified by:
getFieldValue in interface TBase<HighlightOptions,HighlightOptions._Fields>

isSet

public boolean isSet(HighlightOptions._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

Specified by:
isSet in interface TBase<HighlightOptions,HighlightOptions._Fields>

equals

public boolean equals(Object that)
Overrides:
equals in class Object

equals

public boolean equals(HighlightOptions that)

hashCode

public int hashCode()
Overrides:
hashCode in class Object

compareTo

public int compareTo(HighlightOptions other)
Specified by:
compareTo in interface Comparable<HighlightOptions>

fieldForId

public HighlightOptions._Fields fieldForId(int fieldId)
Description copied from interface: TBase
Get the F instance that corresponds to fieldId.

Specified by:
fieldForId in interface TBase<HighlightOptions,HighlightOptions._Fields>

read

public void read(TProtocol iprot)
          throws TException
Description copied from interface: TBase
Reads the TObject from the given input protocol.

Specified by:
read in interface TBase<HighlightOptions,HighlightOptions._Fields>
Parameters:
iprot - Input protocol
Throws:
TException

write

public void write(TProtocol oprot)
           throws TException
Description copied from interface: TBase
Writes the objects out to the protocol

Specified by:
write in interface TBase<HighlightOptions,HighlightOptions._Fields>
Parameters:
oprot - Output protocol
Throws:
TException

toString

public String toString()
Overrides:
toString in class Object

validate

public void validate()
              throws TException
Throws:
TException


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.