org.terracotta.toolkit.search
Interface ToolkitSearchQuery


public interface ToolkitSearchQuery

Specifies search query parameters


Method Summary
 SearchQueryResultSet execute()
          Execute this search query and return result set.
<T> List<T>
getAggregators()
          Returns aggregators requested in result set.
<T> Set<T>
getAttributes()
          Returns set of attributes requested with each result.
<T> Set<T>
getGroupByAttributes()
          Returns set of group by attributes requested with each result.
 int getMaxResults()
          Returns maximum desired number of results.
 int getResultPageSize()
          Returns max page size for search result retrieval
<T> List<T>
getSortAttributes()
          Returns list of attributes result set will be ordered on.
 boolean requestsKeys()
          Returns true if this query requests keys in result, false otherwise.
 boolean requestsValues()
          Returns true if this query requests values in result, false otherwise.
 

Method Detail

getAttributes

<T> Set<T> getAttributes()
Returns set of attributes requested with each result.


getGroupByAttributes

<T> Set<T> getGroupByAttributes()
Returns set of group by attributes requested with each result.


getSortAttributes

<T> List<T> getSortAttributes()
Returns list of attributes result set will be ordered on.


getAggregators

<T> List<T> getAggregators()
Returns aggregators requested in result set.


getMaxResults

int getMaxResults()
Returns maximum desired number of results.


requestsKeys

boolean requestsKeys()
Returns true if this query requests keys in result, false otherwise.


requestsValues

boolean requestsValues()
Returns true if this query requests values in result, false otherwise.


getResultPageSize

int getResultPageSize()
Returns max page size for search result retrieval


execute

SearchQueryResultSet execute()
                             throws SearchException
Execute this search query and return result set.

Throws:
SearchException


Copyright © 2014 Terracotta, Inc.. All Rights Reserved.