Search (cloudant-client 2.0.0 API)

java.lang.Object
- com.cloudant.client.api.Search

public class Search
extends java.lang.Object

This class provides access to the Cloudant Search APIs.

Usage Example:

 
  List<Bird> birds = db.search("views101/animals")
 	.limit(10)
 	.includeDocs(true)
 	.query("class:bird", Bird.class);

 // groups
 Map<String,List<Bird>> birdGroups = db.search("views101/animals")
 	.limit(10)
 	.includeDocs(true)
 	.queryGroups("class:bird", Bird.class);
 for ( Entry<String, List<Bird>> group : birdGroups.entrySet()) {
 		System.out.println("Group Name : " +  group.getKey());
 		for ( Bird b : group.getValue() ) {
 			 System.out.println("\t" + b);
 		 }
 	}

  // search results object
  SearchResult<Bird> result = db.search("views101/animals")
   .querySearchResult("class:bird", Bird.class);

  // pagination
  SearchResult<Bird> nextPage = db.search("views101/animals")
   .bookmark(result.bookmark)
   .querySearchResult("class:bird", Bird.class);

Since:: 0.0.1
See Also:: Database.search(String), SearchResult

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Search`	`bookmark(java.lang.String bookmark)` Control which page of results to get.
`Search`	`counts(java.lang.String[] countsfields)` Array of fieldNames for which counts should be produced
`Search`	`drillDown(java.lang.String fieldName, java.lang.String fieldValue)`
`Search`	`groupField(java.lang.String fieldName, boolean isNumber)` Group results by the specified field.
`Search`	`groupLimit(int limit)` Maximum group count when groupField is set
`Search`	`groupSort(java.lang.String groupsortJson)` the sort order of the groups when groupField is set
`Search`	`includeDocs(java.lang.Boolean includeDocs)`
`Search`	`limit(java.lang.Integer limit)`
`<T> java.util.List<T>`	`query(java.lang.String query, java.lang.Class<T> classOfT)` Queries a Search Index and returns ungrouped results.
`java.io.InputStream`	`queryForStream(java.lang.String query)` Performs a Cloudant Search and returns the result as an `InputStream`
`<T> java.util.Map<java.lang.String,java.util.List<T>>`	`queryGroups(java.lang.String query, java.lang.Class<T> classOfT)` Queries a Search Index and returns grouped results in a map where key of the map is the groupName.
`<T> SearchResult<T>`	`querySearchResult(java.lang.String query, java.lang.Class<T> classOfT)` Performs a Cloudant Search and returns the result as an `SearchResult`
`Search`	`ranges(java.lang.String rangesJson)` Ranges for faceted searches
`Search`	`sort(java.lang.String sortJson)` Specify the sort order for the result.
`Search`	`stale(boolean stale)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - queryForStream
```
public java.io.InputStream queryForStream(java.lang.String query)
```
    Performs a Cloudant Search and returns the result as an InputStream
    
    Parameters:
    
    query - the Lucene query to be passed to the Search index
    The stream should be properly closed after usage, as to avoid connection leaks.
    
    Returns:
    
    The result as an InputStream.
  - query
```
public <T> java.util.List<T> query(java.lang.String query,
                                   java.lang.Class<T> classOfT)
```
    Queries a Search Index and returns ungrouped results. In case the query used grouping, an empty list is returned
    
    Type Parameters:
    
    T - Object type T
    
    Parameters:
    
    query - the Lucene query to be passed to the Search index
    
    classOfT - The class of type T
    
    Returns:
    
    The result of the search query as a List<T>
  - queryGroups
```
public <T> java.util.Map<java.lang.String,java.util.List<T>> queryGroups(java.lang.String query,
                                                                         java.lang.Class<T> classOfT)
```
    Queries a Search Index and returns grouped results in a map where key of the map is the groupName. In case the query didnt use grouping, an empty map is returned
    
    Type Parameters:
    
    T - Object type T
    
    Parameters:
    
    query - the Lucene query to be passed to the Search index
    
    classOfT - The class of type T
    
    Returns:
    
    The result of the grouped search query as a ordered Map<String,T>
  - querySearchResult
```
public <T> SearchResult<T> querySearchResult(java.lang.String query,
                                             java.lang.Class<T> classOfT)
```
    Performs a Cloudant Search and returns the result as an SearchResult
    
    Type Parameters:
    
    T - Object type T, an instance into which the rows[].doc/group[].rows[].doc attribute of the Search result response should be deserialized into. Same goes for the rows[].fields/group[].rows[].fields attribute
    
    Parameters:
    
    query - the Lucene query to be passed to the Search index
    
    classOfT - The class of type T.
    
    Returns:
    
    The Search result entries
  - limit
```
public Search limit(java.lang.Integer limit)
```
    Parameters:
    
    limit - limit the number of documents in the result
    
    Returns:
    
    this for additional parameter setting or to query
  - bookmark
```
public Search bookmark(java.lang.String bookmark)
```
    Control which page of results to get. The bookmark value is obtained by executing the query()/queryForStream() once and getting it from the bookmark field in the response
    
    Parameters:
    
    bookmark - see the next page of results after this bookmark result
    
    Returns:
    
    this for additional parameter setting or to query
  - sort
```
public Search sort(java.lang.String sortJson)
```
    Specify the sort order for the result.
    
    Parameters:
    
    sortJson - JSON string specifying the sort order
    
    Returns:
    
    this for additional parameter setting or to query
    
    See Also:
    
    sort query parameter format
  - groupField
```
public Search groupField(java.lang.String fieldName,
                         boolean isNumber)
```
    Group results by the specified field.
    
    Parameters:
    
    fieldName - by which to group results
    
    isNumber - whether field isNumeric.
    
    Returns:
    
    this for additional parameter setting or to query
  - groupLimit
```
public Search groupLimit(int limit)
```
    Maximum group count when groupField is set
    
    Parameters:
    
    limit - the maximum group count
    
    Returns:
    
    this for additional parameter setting or to query
  - groupSort
```
public Search groupSort(java.lang.String groupsortJson)
```
    the sort order of the groups when groupField is set
    
    Parameters:
    
    groupsortJson - JSON string specifying the group sort
    
    Returns:
    
    this for additional parameter setting or to query
    
    See Also:
    
    sort query parameter format
  - ranges
```
public Search ranges(java.lang.String rangesJson)
```
    Ranges for faceted searches
    
    Parameters:
    
    rangesJson - JSON string specifying the ranges
    
    Returns:
    
    this for additional parameter setting or to query
    
    See Also:
    
    ranges query argument format
  - counts
```
public Search counts(java.lang.String[] countsfields)
```
    Array of fieldNames for which counts should be produced
    
    Parameters:
    
    countsfields - array of the field names
    
    Returns:
    
    this for additional parameter setting or to query
  - drillDown
```
public Search drillDown(java.lang.String fieldName,
                        java.lang.String fieldValue)
```
    Parameters:
    
    fieldName - the name of the field
    
    fieldValue - the value of the field
    
    Returns:
    
    this for additional parameter setting or to query
    
    See Also:
    
    drilldown query parameter
  - stale
```
public Search stale(boolean stale)
```
    Parameters:
    
    stale - Accept values: ok
    
    Returns:
    
    this for additional parameter setting or to query
  - includeDocs
```
public Search includeDocs(java.lang.Boolean includeDocs)
```
    Parameters:
    
    includeDocs - whether to include the document in the result
    
    Returns:
    
    this for additional parameter setting or to query

Class Search

Method Summary

Methods inherited from class java.lang.Object

Method Detail

queryForStream

query

queryGroups

querySearchResult

limit

bookmark

sort

groupField

groupLimit

groupSort

ranges

counts

drillDown

stale

includeDocs