|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.blur.thrift.generated.HighlightOptions
public class HighlightOptions
The HighlightOptions controls how the data is fetched and returned.
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 |
---|
public Query query
public String preTag
public String postTag
public static final Map<HighlightOptions._Fields,FieldMetaData> metaDataMap
Constructor Detail |
---|
public HighlightOptions()
public HighlightOptions(Query query, String preTag, String postTag)
public HighlightOptions(HighlightOptions other)
Method Detail |
---|
public HighlightOptions deepCopy()
deepCopy
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public void clear()
TBase
clear
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public Query getQuery()
public HighlightOptions setQuery(Query query)
public void unsetQuery()
public boolean isSetQuery()
public void setQueryIsSet(boolean value)
public String getPreTag()
public HighlightOptions setPreTag(String preTag)
public void unsetPreTag()
public boolean isSetPreTag()
public void setPreTagIsSet(boolean value)
public String getPostTag()
public HighlightOptions setPostTag(String postTag)
public void unsetPostTag()
public boolean isSetPostTag()
public void setPostTagIsSet(boolean value)
public void setFieldValue(HighlightOptions._Fields field, Object value)
TBase
setFieldValue
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public Object getFieldValue(HighlightOptions._Fields field)
TBase
getFieldValue
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public boolean isSet(HighlightOptions._Fields field)
isSet
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public boolean equals(Object that)
equals
in class Object
public boolean equals(HighlightOptions that)
public int hashCode()
hashCode
in class Object
public int compareTo(HighlightOptions other)
compareTo
in interface Comparable<HighlightOptions>
public HighlightOptions._Fields fieldForId(int fieldId)
TBase
fieldForId
in interface TBase<HighlightOptions,HighlightOptions._Fields>
public void read(TProtocol iprot) throws TException
TBase
read
in interface TBase<HighlightOptions,HighlightOptions._Fields>
iprot
- Input protocol
TException
public void write(TProtocol oprot) throws TException
TBase
write
in interface TBase<HighlightOptions,HighlightOptions._Fields>
oprot
- Output protocol
TException
public String toString()
toString
in class Object
public void validate() throws TException
TException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |