public interface Searcher
A builder that helps to build search queries over assets. A search query can be built with specifications as follows:
FilterBuilder
interface. Sort order for results can be specified using the OrderBuilder
interface.Query
Modifier and Type | Method and Description |
---|---|
Searcher |
filter(Filter filter)
Sets a filter condition in the query built by this builder.
|
Searcher |
from(String type, String... subtypes)
Sets the type and subtypes to search assets against.
|
Searcher |
inSite(String site)
Sets the site to search assets from.
|
Searcher |
orderBy(Orders order)
Sets a ordering sequence for the results.
|
List<Map<String,String>> |
search()
Performs the search using the query built by this builder and returns the results.
|
List<Map<String,String>> |
searchFor(String phrase)
Performs the search using the phrase on the default search field and the query built by this builder and returns the results.
|
Searcher |
select(String fields, String... moreFields)
Sets the fields to select from results returned by search using the query built by this builder.
|
Searcher |
selectAll()
Flags that all fields in the results should be returned by the search invoked by this builder.
|
Searcher |
startAt(int index)
Sets the start index for the results page.
|
Searcher |
top(int pageSize)
Sets the number of results to return.
|
List<Map<String,String>> searchFor(String phrase) throws SearchException
phrase
- a phrase to search in the default search field.List
containing the search results.SearchException
- thrown from underlying implementation.Searcher select(String fields, String... moreFields)
fields
- the fields to select from the results returned.moreFields
- optional more fields to select from the results returned.Searcher.selectAll()
Searcher selectAll()
Searcher.select(String, String...)
method are reset. If Searcher.select(String, String...)
is invoked again with specified set of fields, then the effect of this method is cancelled and only the specified fields are returned.Searcher.select(String, String...)
Searcher top(int pageSize)
pageSize
- the maximum size of the result page to return.Searcher.startAt(int)
Searcher startAt(int index)
index
- the starting index of the result page to return.Searcher.top(int)
Searcher from(String type, String... subtypes)
type
- the asset type to search against.subtypes
- optionally the subtype to search against.Searcher inSite(String site)
site
- a site nameSearcher filter(Filter filter)
filter
- a filterFilter
, FilterBuilder
, FilterBuilder.FilterFinalizer
Searcher orderBy(Orders order)
order
- an orderOrder
, Orders
, OrderBuilder
, OrderBuilder.OrderChainBuilder
List<Map<String,String>> search() throws SearchException
List<Map<String, String>>
representing the search results.SearchException
- when one of the mandatory validation condition checks fail. The message in the exception can detail which check failed.