org.apache.blur.thrift.generated
Class Facet

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

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

Blur facet.

See Also:
Serialized Form

Nested Class Summary
static class Facet._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static Map<Facet._Fields,FieldMetaData> metaDataMap
           
 long minimumNumberOfBlurResults
          The minimum number of results before no longer processing the facet.
 String queryStr
          The facet query.
 
Constructor Summary
Facet()
           
Facet(Facet other)
          Performs a deep copy on other.
Facet(String queryStr, long minimumNumberOfBlurResults)
           
 
Method Summary
 void clear()
          Return to the state of having just been initialized, as though you had just called the default constructor.
 int compareTo(Facet other)
           
 Facet deepCopy()
           
 boolean equals(Facet that)
           
 boolean equals(Object that)
           
 Facet._Fields fieldForId(int fieldId)
          Get the F instance that corresponds to fieldId.
 Object getFieldValue(Facet._Fields field)
          Get a field's value by field variable.
 long getMinimumNumberOfBlurResults()
          The minimum number of results before no longer processing the facet.
 String getQueryStr()
          The facet query.
 int hashCode()
           
 boolean isSet(Facet._Fields field)
          Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
 boolean isSetMinimumNumberOfBlurResults()
          Returns true if field minimumNumberOfBlurResults is set (has been assigned a value) and false otherwise
 boolean isSetQueryStr()
          Returns true if field queryStr is set (has been assigned a value) and false otherwise
 void read(TProtocol iprot)
          Reads the TObject from the given input protocol.
 void setFieldValue(Facet._Fields field, Object value)
          Set a field's value by field variable.
 Facet setMinimumNumberOfBlurResults(long minimumNumberOfBlurResults)
          The minimum number of results before no longer processing the facet.
 void setMinimumNumberOfBlurResultsIsSet(boolean value)
           
 Facet setQueryStr(String queryStr)
          The facet query.
 void setQueryStrIsSet(boolean value)
           
 String toString()
           
 void unsetMinimumNumberOfBlurResults()
           
 void unsetQueryStr()
           
 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

queryStr

public String queryStr
The facet query.


minimumNumberOfBlurResults

public long minimumNumberOfBlurResults
The minimum number of results before no longer processing the facet. This is a good way to decrease the strain on the system while using many facets. For example if you set this attribute to 1000, then the shard server will stop processing the facet at the 1000 mark. However because this is processed at the shard server level the controller will likely return more than the minimum because it sums the answers from the shard servers.


metaDataMap

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

Facet

public Facet()

Facet

public Facet(String queryStr,
             long minimumNumberOfBlurResults)

Facet

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

Method Detail

deepCopy

public Facet deepCopy()
Specified by:
deepCopy in interface TBase<Facet,Facet._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<Facet,Facet._Fields>

getQueryStr

public String getQueryStr()
The facet query.


setQueryStr

public Facet setQueryStr(String queryStr)
The facet query.


unsetQueryStr

public void unsetQueryStr()

isSetQueryStr

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


setQueryStrIsSet

public void setQueryStrIsSet(boolean value)

getMinimumNumberOfBlurResults

public long getMinimumNumberOfBlurResults()
The minimum number of results before no longer processing the facet. This is a good way to decrease the strain on the system while using many facets. For example if you set this attribute to 1000, then the shard server will stop processing the facet at the 1000 mark. However because this is processed at the shard server level the controller will likely return more than the minimum because it sums the answers from the shard servers.


setMinimumNumberOfBlurResults

public Facet setMinimumNumberOfBlurResults(long minimumNumberOfBlurResults)
The minimum number of results before no longer processing the facet. This is a good way to decrease the strain on the system while using many facets. For example if you set this attribute to 1000, then the shard server will stop processing the facet at the 1000 mark. However because this is processed at the shard server level the controller will likely return more than the minimum because it sums the answers from the shard servers.


unsetMinimumNumberOfBlurResults

public void unsetMinimumNumberOfBlurResults()

isSetMinimumNumberOfBlurResults

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


setMinimumNumberOfBlurResultsIsSet

public void setMinimumNumberOfBlurResultsIsSet(boolean value)

setFieldValue

public void setFieldValue(Facet._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<Facet,Facet._Fields>

getFieldValue

public Object getFieldValue(Facet._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<Facet,Facet._Fields>

isSet

public boolean isSet(Facet._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<Facet,Facet._Fields>

equals

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

equals

public boolean equals(Facet that)

hashCode

public int hashCode()
Overrides:
hashCode in class Object

compareTo

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

fieldForId

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

Specified by:
fieldForId in interface TBase<Facet,Facet._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<Facet,Facet._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<Facet,Facet._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.