SearchRequestParams (biocache-service 1.3 API)

java.lang.Object
- au.org.ala.biocache.dto.SearchRequestParams

Direct Known Subclasses:

SpatialSearchRequestParams
```
public class SearchRequestParams
extends Object
```
Data Transfer Object to represent the request parameters required to search for occurrence records against biocache-service.

Author:

"Nick dos Remedios "

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`dir`
`protected Boolean`	`facet` To disable facets
`protected String[]`	`facets` The facets to be included by the search Initialised with the default facets to use
`protected String`	`fl`
`protected Integer`	`flimit`
`protected Integer`	`foffset` The offset of facets to return.
`protected String`	`formattedQuery`
`protected String`	`fprefix` The prefix to limit facet values
`protected String[]`	`fq`
`protected String`	`fsort` The sort order in which to return the facets.
`protected Integer`	`pageSize`
`protected String`	`q`
`protected String`	`qc` The query context to be used for the search.
`protected Long`	`qId` Only used to store the formattedQuery to be passed around in biocache-service
`protected String`	`sort`
`protected Integer`	`start`

Constructor Summary

Constructors
Constructor and Description

SearchRequestParams()

Constructors
Constructor and Description
`SearchRequestParams()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`conditionalEncode(String input, Boolean isEncoded)` URI encode the param value if isEncoded is true
`String`	`getDir()` Get the value of dir
`String`	`getDisplayString()`
`String`	`getEncodedParams()` Produce a URI encoded query string for use in java.util.URI, etc
`Boolean`	`getFacet()`
`String[]`	`getFacets()`
`String`	`getFl()`
`Integer`	`getFlimit()`
`Integer`	`getFoffset()`
`String`	`getFormattedQuery()`
`String`	`getFprefix()`
`String[]`	`getFq()` Get the value of fq
`String`	`getFsort()`
`Integer`	`getPageSize()` Get the value of pageSize
`String`	`getQ()` Get the value of q
`String`	`getQc()`
`Long`	`getQId()`
`String`	`getSort()` Get the value of sort
`Integer`	`getStart()` Get the value of start
`Integer`	`getStartIndex()` Set the value of start
`String`	`getUrlParams()` Constructs the params to be returned in the result
`int`	`hashCode()`
`void`	`setDir(String sortDirection)` Set the value of dir
`void`	`setDisplayString(String displayString)`
`void`	`setFacet(Boolean facet)`
`void`	`setFacets(String[] facets)`
`void`	`setFl(String fl)`
`void`	`setFlimit(Integer flimit)`
`void`	`setFoffset(Integer foffset)`
`void`	`setFormattedQuery(String formattedQuery)`
`void`	`setFprefix(String fprefix)`
`void`	`setFq(String[] filterQuery)` Set the value of fq
`void`	`setFsort(String fsort)`
`void`	`setPageSize(Integer pageSize)` Set the value of pageSize
`void`	`setQ(String query)` Set the value of q
`void`	`setQc(String qc)`
`void`	`setQId(Long qId)`
`void`	`setSort(String sort)` Set the value of sort
`void`	`setStart(Integer start)` Set the value of start
`void`	`setStartIndex(Integer startIndex)` Set the value of start
`String`	`toString()` Custom toString method to produce a String to be used as the request parameters for the Biocache Service webservices
`protected String`	`toString(Boolean encodeParams)` Common code to output a param string with conditional encoding of values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - qId
```
protected Long qId
```
    Only used to store the formattedQuery to be passed around in biocache-service
  - formattedQuery
```
protected String formattedQuery
```
  - q
```
protected String q
```
  - fq
```
protected String[] fq
```
  - fl
```
protected String fl
```
  - facets
```
protected String[] facets
```
    The facets to be included by the search Initialised with the default facets to use
  - start
```
protected Integer start
```
  - flimit
```
protected Integer flimit
```
  - fsort
```
protected String fsort
```
    The sort order in which to return the facets. Either count or index. When empty string the default values are used as defined in the Theme based facets
  - foffset
```
protected Integer foffset
```
    The offset of facets to return. Used in conjunction to flimit
  - fprefix
```
protected String fprefix
```
    The prefix to limit facet values
  - pageSize
```
protected Integer pageSize
```
  - sort
```
protected String sort
```
  - dir
```
protected String dir
```
  - qc
```
protected String qc
```
    The query context to be used for the search. This will be used to generate extra query filters based on the search technology
  - facet
```
protected Boolean facet
```
    To disable facets
- Constructor Detail
  - SearchRequestParams
```
public SearchRequestParams()
```
- Method Detail
  - toString
```
public String toString()
```
    Custom toString method to produce a String to be used as the request parameters for the Biocache Service webservices
    
    Overrides:
    
    toString in class Object
    
    Returns:
    request parameters string
  - getEncodedParams
```
public String getEncodedParams()
```
    Produce a URI encoded query string for use in java.util.URI, etc
    
    Returns:
    encoded query string
  - toString
```
protected String toString(Boolean encodeParams)
```
    Common code to output a param string with conditional encoding of values
    
    Parameters:
    encodeParams -
    
    Returns:
    query string
  - conditionalEncode
```
protected String conditionalEncode(String input,
                       Boolean isEncoded)
```
    URI encode the param value if isEncoded is true
    
    Parameters:
    input -
    isEncoded -
    
    Returns:
    query string
  - getUrlParams
```
public String getUrlParams()
```
    Constructs the params to be returned in the result
    
    Returns:
    req
  - getQ
```
public String getQ()
```
    Get the value of q
    
    Returns:
    the value of q
  - setQ
```
public void setQ(String query)
```
    Set the value of q
    
    Parameters:
    query - new value of q
  - getQId
```
public Long getQId()
```
  - setQId
```
public void setQId(Long qId)
```
  - getFq
```
public String[] getFq()
```
    Get the value of fq
    
    Returns:
    the value of fq
  - setFq
```
public void setFq(String[] filterQuery)
```
    Set the value of fq
    
    Parameters:
    filterQuery - new value of fq
  - getStart
```
public Integer getStart()
```
    Get the value of start
    
    Returns:
    the value of start
  - setStart
```
public void setStart(Integer start)
```
    Set the value of start
    
    Parameters:
    start - new value of start
  - setStartIndex
```
public void setStartIndex(Integer startIndex)
```
    Set the value of start
    
    Parameters:
    startIndex - new value of start
  - getStartIndex
```
public Integer getStartIndex()
```
    Set the value of start
  - getPageSize
```
public Integer getPageSize()
```
    Get the value of pageSize
    
    Returns:
    the value of pageSize
  - setPageSize
```
public void setPageSize(Integer pageSize)
```
    Set the value of pageSize
    
    Parameters:
    pageSize - new value of pageSize
  - getSort
```
public String getSort()
```
    Get the value of sort
    
    Returns:
    the value of sort
  - setSort
```
public void setSort(String sort)
```
    Set the value of sort
    
    Parameters:
    sort - new value of sort
  - getDir
```
public String getDir()
```
    Get the value of dir
    
    Returns:
    the value of dir
  - setDir
```
public void setDir(String sortDirection)
```
    Set the value of dir
    
    Parameters:
    sortDirection - new value of dir
  - getDisplayString
```
public String getDisplayString()
```
  - setDisplayString
```
public void setDisplayString(String displayString)
```
  - getFacets
```
public String[] getFacets()
```
  - setFacets
```
public void setFacets(String[] facets)
```
  - getFlimit
```
public Integer getFlimit()
```
  - setFlimit
```
public void setFlimit(Integer flimit)
```
  - getQc
```
public String getQc()
```
  - setQc
```
public void setQc(String qc)
```
  - getFl
```
public String getFl()
```
  - setFl
```
public void setFl(String fl)
```
  - getFormattedQuery
```
public String getFormattedQuery()
```
    Returns:
    the formattedQuery
  - setFormattedQuery
```
public void setFormattedQuery(String formattedQuery)
```
    Parameters:
    formattedQuery - the formattedQuery to set
  - getFacet
```
public Boolean getFacet()
```
  - setFacet
```
public void setFacet(Boolean facet)
```
  - getFsort
```
public String getFsort()
```
    Returns:
    the fsort
  - setFsort
```
public void setFsort(String fsort)
```
    Parameters:
    fsort - the fsort to set
  - getFoffset
```
public Integer getFoffset()
```
    Returns:
    the foffset
  - setFoffset
```
public void setFoffset(Integer foffset)
```
    Parameters:
    foffset - the foffset to set
  - getFprefix
```
public String getFprefix()
```
    Returns:
    the fprefix
  - setFprefix
```
public void setFprefix(String fprefix)
```
    Parameters:
    fprefix - the fprefix to set
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class SearchRequestParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

qId

formattedQuery

q

fq

fl

facets

start

flimit

fsort

foffset

fprefix

pageSize

sort

dir

qc

facet

Constructor Detail

SearchRequestParams

Method Detail

toString

getEncodedParams

toString

conditionalEncode

getUrlParams

getQ

setQ

getQId

setQId

getFq

setFq

getStart

setStart

setStartIndex

getStartIndex

getPageSize

setPageSize

getSort

setSort

getDir

setDir

getDisplayString

setDisplayString

getFacets

setFacets

getFlimit

setFlimit

getQc

setQc

getFl

setFl

getFormattedQuery

setFormattedQuery

getFacet

setFacet

getFsort

setFsort

getFoffset

setFoffset

getFprefix

setFprefix

hashCode