|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.blur.thrift.generated.BlurQuery
public class BlurQuery
The Blur Query object that contains the query that needs to be executed along with the query options.
Nested Class Summary | |
---|---|
static class |
BlurQuery._Fields
The set of fields this struct contains, along with convenience methods for finding and manipulating them. |
Field Summary | |
---|---|
boolean |
cacheResult
Enabled by default to cache this result. |
List<Facet> |
facets
A list of Facets to execute with the given query. |
int |
fetch
The number of fetched results, 10 by default. |
long |
maxQueryTime
The maximum amount of time the query should execute before timing out. |
static Map<BlurQuery._Fields,FieldMetaData> |
metaDataMap
|
long |
minimumNumberOfResults
The minimum number of results to find before returning. |
Query |
query
The query information. |
String |
rowId
Optional optimization for record queries to run against a single row. |
Selector |
selector
Selector is used to fetch data in the search results, if null only location ids will be fetched. |
List<SortField> |
sortFields
The sortfields are applied in order to sort the results. |
long |
start
The starting result position, 0 by default. |
long |
startTime
Sets the start time, if 0 the controller sets the time. |
boolean |
useCacheIfPresent
Enabled by default to use a cached result if the query matches a previous run query with the configured amount of time. |
String |
userContext
Sets a user context, only used for logging at this point. |
String |
uuid
Sets the uuid of this query, this is normal set by the client so that the status of a running query can be found or the query can be canceled. |
Constructor Summary | |
---|---|
BlurQuery()
|
|
BlurQuery(BlurQuery other)
Performs a deep copy on other. |
|
BlurQuery(Query query,
List<Facet> facets,
Selector selector,
boolean useCacheIfPresent,
long start,
int fetch,
long minimumNumberOfResults,
long maxQueryTime,
String uuid,
String userContext,
boolean cacheResult,
long startTime,
List<SortField> sortFields,
String rowId)
|
Method Summary | |
---|---|
void |
addToFacets(Facet elem)
|
void |
addToSortFields(SortField elem)
|
void |
clear()
Return to the state of having just been initialized, as though you had just called the default constructor. |
int |
compareTo(BlurQuery other)
|
BlurQuery |
deepCopy()
|
boolean |
equals(BlurQuery that)
|
boolean |
equals(Object that)
|
BlurQuery._Fields |
fieldForId(int fieldId)
Get the F instance that corresponds to fieldId. |
List<Facet> |
getFacets()
A list of Facets to execute with the given query. |
Iterator<Facet> |
getFacetsIterator()
|
int |
getFacetsSize()
|
int |
getFetch()
The number of fetched results, 10 by default. |
Object |
getFieldValue(BlurQuery._Fields field)
Get a field's value by field variable. |
long |
getMaxQueryTime()
The maximum amount of time the query should execute before timing out. |
long |
getMinimumNumberOfResults()
The minimum number of results to find before returning. |
Query |
getQuery()
The query information. |
String |
getRowId()
Optional optimization for record queries to run against a single row. |
Selector |
getSelector()
Selector is used to fetch data in the search results, if null only location ids will be fetched. |
List<SortField> |
getSortFields()
The sortfields are applied in order to sort the results. |
Iterator<SortField> |
getSortFieldsIterator()
|
int |
getSortFieldsSize()
|
long |
getStart()
The starting result position, 0 by default. |
long |
getStartTime()
Sets the start time, if 0 the controller sets the time. |
String |
getUserContext()
Sets a user context, only used for logging at this point. |
String |
getUuid()
Sets the uuid of this query, this is normal set by the client so that the status of a running query can be found or the query can be canceled. |
int |
hashCode()
|
boolean |
isCacheResult()
Enabled by default to cache this result. |
boolean |
isSet(BlurQuery._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise |
boolean |
isSetCacheResult()
Returns true if field cacheResult is set (has been assigned a value) and false otherwise |
boolean |
isSetFacets()
Returns true if field facets is set (has been assigned a value) and false otherwise |
boolean |
isSetFetch()
Returns true if field fetch is set (has been assigned a value) and false otherwise |
boolean |
isSetMaxQueryTime()
Returns true if field maxQueryTime is set (has been assigned a value) and false otherwise |
boolean |
isSetMinimumNumberOfResults()
Returns true if field minimumNumberOfResults 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 |
boolean |
isSetRowId()
Returns true if field rowId is set (has been assigned a value) and false otherwise |
boolean |
isSetSelector()
Returns true if field selector is set (has been assigned a value) and false otherwise |
boolean |
isSetSortFields()
Returns true if field sortFields is set (has been assigned a value) and false otherwise |
boolean |
isSetStart()
Returns true if field start is set (has been assigned a value) and false otherwise |
boolean |
isSetStartTime()
Returns true if field startTime is set (has been assigned a value) and false otherwise |
boolean |
isSetUseCacheIfPresent()
Returns true if field useCacheIfPresent is set (has been assigned a value) and false otherwise |
boolean |
isSetUserContext()
Returns true if field userContext is set (has been assigned a value) and false otherwise |
boolean |
isSetUuid()
Returns true if field uuid is set (has been assigned a value) and false otherwise |
boolean |
isUseCacheIfPresent()
Enabled by default to use a cached result if the query matches a previous run query with the configured amount of time. |
void |
read(TProtocol iprot)
Reads the TObject from the given input protocol. |
BlurQuery |
setCacheResult(boolean cacheResult)
Enabled by default to cache this result. |
void |
setCacheResultIsSet(boolean value)
|
BlurQuery |
setFacets(List<Facet> facets)
A list of Facets to execute with the given query. |
void |
setFacetsIsSet(boolean value)
|
BlurQuery |
setFetch(int fetch)
The number of fetched results, 10 by default. |
void |
setFetchIsSet(boolean value)
|
void |
setFieldValue(BlurQuery._Fields field,
Object value)
Set a field's value by field variable. |
BlurQuery |
setMaxQueryTime(long maxQueryTime)
The maximum amount of time the query should execute before timing out. |
void |
setMaxQueryTimeIsSet(boolean value)
|
BlurQuery |
setMinimumNumberOfResults(long minimumNumberOfResults)
The minimum number of results to find before returning. |
void |
setMinimumNumberOfResultsIsSet(boolean value)
|
BlurQuery |
setQuery(Query query)
The query information. |
void |
setQueryIsSet(boolean value)
|
BlurQuery |
setRowId(String rowId)
Optional optimization for record queries to run against a single row. |
void |
setRowIdIsSet(boolean value)
|
BlurQuery |
setSelector(Selector selector)
Selector is used to fetch data in the search results, if null only location ids will be fetched. |
void |
setSelectorIsSet(boolean value)
|
BlurQuery |
setSortFields(List<SortField> sortFields)
The sortfields are applied in order to sort the results. |
void |
setSortFieldsIsSet(boolean value)
|
BlurQuery |
setStart(long start)
The starting result position, 0 by default. |
void |
setStartIsSet(boolean value)
|
BlurQuery |
setStartTime(long startTime)
Sets the start time, if 0 the controller sets the time. |
void |
setStartTimeIsSet(boolean value)
|
BlurQuery |
setUseCacheIfPresent(boolean useCacheIfPresent)
Enabled by default to use a cached result if the query matches a previous run query with the configured amount of time. |
void |
setUseCacheIfPresentIsSet(boolean value)
|
BlurQuery |
setUserContext(String userContext)
Sets a user context, only used for logging at this point. |
void |
setUserContextIsSet(boolean value)
|
BlurQuery |
setUuid(String uuid)
Sets the uuid of this query, this is normal set by the client so that the status of a running query can be found or the query can be canceled. |
void |
setUuidIsSet(boolean value)
|
String |
toString()
|
void |
unsetCacheResult()
|
void |
unsetFacets()
|
void |
unsetFetch()
|
void |
unsetMaxQueryTime()
|
void |
unsetMinimumNumberOfResults()
|
void |
unsetQuery()
|
void |
unsetRowId()
|
void |
unsetSelector()
|
void |
unsetSortFields()
|
void |
unsetStart()
|
void |
unsetStartTime()
|
void |
unsetUseCacheIfPresent()
|
void |
unsetUserContext()
|
void |
unsetUuid()
|
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 List<Facet> facets
public Selector selector
public boolean useCacheIfPresent
public long start
public int fetch
public long minimumNumberOfResults
public long maxQueryTime
public String uuid
public String userContext
public boolean cacheResult
public long startTime
public List<SortField> sortFields
public String rowId
public static final Map<BlurQuery._Fields,FieldMetaData> metaDataMap
Constructor Detail |
---|
public BlurQuery()
public BlurQuery(Query query, List<Facet> facets, Selector selector, boolean useCacheIfPresent, long start, int fetch, long minimumNumberOfResults, long maxQueryTime, String uuid, String userContext, boolean cacheResult, long startTime, List<SortField> sortFields, String rowId)
public BlurQuery(BlurQuery other)
Method Detail |
---|
public BlurQuery deepCopy()
deepCopy
in interface TBase<BlurQuery,BlurQuery._Fields>
public void clear()
TBase
clear
in interface TBase<BlurQuery,BlurQuery._Fields>
public Query getQuery()
public BlurQuery setQuery(Query query)
public void unsetQuery()
public boolean isSetQuery()
public void setQueryIsSet(boolean value)
public int getFacetsSize()
public Iterator<Facet> getFacetsIterator()
public void addToFacets(Facet elem)
public List<Facet> getFacets()
public BlurQuery setFacets(List<Facet> facets)
public void unsetFacets()
public boolean isSetFacets()
public void setFacetsIsSet(boolean value)
public Selector getSelector()
public BlurQuery setSelector(Selector selector)
public void unsetSelector()
public boolean isSetSelector()
public void setSelectorIsSet(boolean value)
public boolean isUseCacheIfPresent()
public BlurQuery setUseCacheIfPresent(boolean useCacheIfPresent)
public void unsetUseCacheIfPresent()
public boolean isSetUseCacheIfPresent()
public void setUseCacheIfPresentIsSet(boolean value)
public long getStart()
public BlurQuery setStart(long start)
public void unsetStart()
public boolean isSetStart()
public void setStartIsSet(boolean value)
public int getFetch()
public BlurQuery setFetch(int fetch)
public void unsetFetch()
public boolean isSetFetch()
public void setFetchIsSet(boolean value)
public long getMinimumNumberOfResults()
public BlurQuery setMinimumNumberOfResults(long minimumNumberOfResults)
public void unsetMinimumNumberOfResults()
public boolean isSetMinimumNumberOfResults()
public void setMinimumNumberOfResultsIsSet(boolean value)
public long getMaxQueryTime()
public BlurQuery setMaxQueryTime(long maxQueryTime)
public void unsetMaxQueryTime()
public boolean isSetMaxQueryTime()
public void setMaxQueryTimeIsSet(boolean value)
public String getUuid()
public BlurQuery setUuid(String uuid)
public void unsetUuid()
public boolean isSetUuid()
public void setUuidIsSet(boolean value)
public String getUserContext()
public BlurQuery setUserContext(String userContext)
public void unsetUserContext()
public boolean isSetUserContext()
public void setUserContextIsSet(boolean value)
public boolean isCacheResult()
public BlurQuery setCacheResult(boolean cacheResult)
public void unsetCacheResult()
public boolean isSetCacheResult()
public void setCacheResultIsSet(boolean value)
public long getStartTime()
public BlurQuery setStartTime(long startTime)
public void unsetStartTime()
public boolean isSetStartTime()
public void setStartTimeIsSet(boolean value)
public int getSortFieldsSize()
public Iterator<SortField> getSortFieldsIterator()
public void addToSortFields(SortField elem)
public List<SortField> getSortFields()
public BlurQuery setSortFields(List<SortField> sortFields)
public void unsetSortFields()
public boolean isSetSortFields()
public void setSortFieldsIsSet(boolean value)
public String getRowId()
public BlurQuery setRowId(String rowId)
public void unsetRowId()
public boolean isSetRowId()
public void setRowIdIsSet(boolean value)
public void setFieldValue(BlurQuery._Fields field, Object value)
TBase
setFieldValue
in interface TBase<BlurQuery,BlurQuery._Fields>
public Object getFieldValue(BlurQuery._Fields field)
TBase
getFieldValue
in interface TBase<BlurQuery,BlurQuery._Fields>
public boolean isSet(BlurQuery._Fields field)
isSet
in interface TBase<BlurQuery,BlurQuery._Fields>
public boolean equals(Object that)
equals
in class Object
public boolean equals(BlurQuery that)
public int hashCode()
hashCode
in class Object
public int compareTo(BlurQuery other)
compareTo
in interface Comparable<BlurQuery>
public BlurQuery._Fields fieldForId(int fieldId)
TBase
fieldForId
in interface TBase<BlurQuery,BlurQuery._Fields>
public void read(TProtocol iprot) throws TException
TBase
read
in interface TBase<BlurQuery,BlurQuery._Fields>
iprot
- Input protocol
TException
public void write(TProtocol oprot) throws TException
TBase
write
in interface TBase<BlurQuery,BlurQuery._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 |