net.opentsdb.search

Class SearchQuery

java.lang.Object

net.opentsdb.search.SearchQuery

public class SearchQuery
extends Object

Class used for passing and executing simple queries against with the search plugin. This may not be able to take advantage of all of the search engine's features but is intended to satisfy most common search requests.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchQuery.SearchType Types of searches to execute, chooses the different indexes and/or alters the output format

Constructor Summary

Constructors

Constructor and Description
SearchQuery()

Method Summary

Methods

Modifier and Type	Method and Description
int	getLimit()
String	getQuery()
List<Object>	getResults()
int	getStartIndex()
float	getTime()
int	getTotalResults()
SearchQuery.SearchType	getType()
static SearchQuery.SearchType	parseSearchType(String type) Converts the human readable string to the proper enum
void	setLimit(int limit)
void	setQuery(String query)
void	setResults(List<Object> results)
void	setStartIndex(int start_index)
void	setTime(float time)
void	setTotalResults(int total_results)
void	setType(SearchQuery.SearchType type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchQuery

public SearchQuery()

Method Detail

parseSearchType

public static SearchQuery.SearchType parseSearchType(String type)

Converts the human readable string to the proper enum

Parameters:

type - The string to parse

Returns:

The parsed enum

Throws:

IllegalArgumentException - if the type is missing or wsa not recognized

getType

public SearchQuery.SearchType getType()

Returns:

The type of query executed

getQuery

public String getQuery()

Returns:

The query itself

getLimit

public int getLimit()

Returns:

A limit on the number of results returned per query

getStartIndex

public int getStartIndex()

Returns:

The starting index for paging through results

getTotalResults

public int getTotalResults()

Returns:

The total results matched on the query

getTime

public float getTime()

Returns:

The amount of time it took to complete the query

getResults

public List<Object> getResults()

Returns:

The array of results. May be an empty list

setType

public void setType(SearchQuery.SearchType type)

Parameters:

type - The type of query to execute

setQuery

public void setQuery(String query)

Parameters:

query - The query to execute

setLimit

public void setLimit(int limit)

Parameters:

limit - A limit to the number of results to return

setStartIndex

public void setStartIndex(int start_index)

Parameters:

start_index - Used for paging through a result set, starts at 0

setTotalResults

public void setTotalResults(int total_results)

Parameters:

total_results - The total number of results matched on the query

setTime

public void setTime(float time)

Parameters:

time - The amount of time it took to complete the query

setResults

public void setResults(List<Object> results)

Parameters:

results - The result set