Package net.dona.doip.client
Class QueryParams
java.lang.Object
net.dona.doip.client.QueryParams
An object for holding query parameters for
DoipClient
search operations.-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstruct default QueryParams, with pageSize = -1 (returns all results).QueryParams
(int pageNum, int pageSize) Construct a QueryParams.QueryParams
(int pageNum, int pageSize, List<SortField> sortFields) QueryParams
(int pageNum, int pageSize, List<SortField> sortFields, List<FacetSpecification> facets) Construct a QueryParams. -
Method Summary
-
Field Details
-
DEFAULT
Default query parameters. Passingnull
to search methods amounts to using this. No pagination and no sorting.
-
-
Constructor Details
-
QueryParams
public QueryParams()Construct default QueryParams, with pageSize = -1 (returns all results). PreferDEFAULT
. -
QueryParams
public QueryParams(int pageNum, int pageSize) Construct a QueryParams.- Parameters:
pageNum
- the page number to return. Starts at 0. Ignored if pageSize <= 0.pageSize
- the number of objects to return. PageSize of < 0 means return all.
-
QueryParams
-
QueryParams
public QueryParams(int pageNum, int pageSize, List<SortField> sortFields, List<FacetSpecification> facets) Construct a QueryParams.- Parameters:
pageNum
- the page number to return. Starts at 0. Ignored if pageSize <= 0.pageSize
- the number of objects to return. PageSize of < 0 means return all.sortFields
- how to sort the resultsfacets
- information about requested faceting When a user specifies a `facets` field in a search request (e.g., `"facets":[{"field":"/bucket"}]` in a JSON object in the body of a POST request), the Cordra indexer provides a `facets` field with an array of facets (e.g., `"facets":[...]`). Each facet contains a `field` field with an array of facets (e.g., `"facets":[...]`). Each facet contains a `field` field with a value `` (e.g., `"field":"/bucket"`). facets is a list of objects encapsulating each value (e.g., a list containing an object encapsulating "/bucket").
-
-
Method Details
-
getPageNum
public int getPageNum() -
getPageSize
public int getPageSize() -
getSortFields
-
getFacets
-
builder
-