au.org.ala.biocache.dto

Class SpatialSearchRequestParams

java.lang.Object

au.org.ala.biocache.dto.SearchRequestParams

au.org.ala.biocache.dto.SpatialSearchRequestParams

Direct Known Subclasses:

BreakdownRequestParams, DownloadRequestParams

public class SpatialSearchRequestParams
extends SearchRequestParams

Data Transfer Object to represent the request parameters required to perform a spatial search on occurrence records against biocache-service.

Author:

"Natasha Carter "

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	gk
protected Float	lat
protected Float	lon
protected Float	radius
protected String	wkt

Fields inherited from class au.org.ala.biocache.dto.SearchRequestParams

dir, facet, facets, fl, flimit, foffset, formattedQuery, fprefix, fq, fsort, pageSize, q, qc, qId, sort, start

Constructor Summary

Constructors

Constructor and Description
SpatialSearchRequestParams()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	addSpatialParams(String paramString, Boolean encodeParams) Add the spatial params to the param string
String	getEncodedParams() Produce a URI encoded query string for use in java.util.URI, etc
String[]	getFq() Get the value of fq.
Boolean	getGk()
Float	getLat()
Float	getLon()
Float	getRadius()
String	getUrlParams() Constructs the params to be returned in the result
String	getWkt()
int	hashCode()
void	setGk(Boolean gk)
void	setLat(Float lat)
void	setLon(Float lon)
void	setRadius(Float radius)
void	setWkt(String wkt)
String	toString() Custom toString method to produce a String to be used as the request parameters for the Biocache Service webservices

Methods inherited from class au.org.ala.biocache.dto.SearchRequestParams

conditionalEncode, getDir, getDisplayString, getFacet, getFacets, getFl, getFlimit, getFoffset, getFormattedQuery, getFprefix, getFsort, getPageSize, getQ, getQc, getQId, getSort, getStart, getStartIndex, setDir, setDisplayString, setFacet, setFacets, setFl, setFlimit, setFoffset, setFormattedQuery, setFprefix, setFq, setFsort, setPageSize, setQ, setQc, setQId, setSort, setStart, setStartIndex, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

radius

protected Float radius

lat

protected Float lat

lon

protected Float lon

wkt

protected String wkt

gk

protected Boolean gk

Constructor Detail

SpatialSearchRequestParams

public SpatialSearchRequestParams()

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 SearchRequestParams

Returns:

request parameters string

getEncodedParams

public String getEncodedParams()

Produce a URI encoded query string for use in java.util.URI, etc

Overrides:

getEncodedParams in class SearchRequestParams

Returns:

addSpatialParams

protected String addSpatialParams(String paramString,
                      Boolean encodeParams)

Add the spatial params to the param string

Parameters:

paramString -

Returns:

getUrlParams

public String getUrlParams()

Description copied from class: SearchRequestParams

Constructs the params to be returned in the result

Overrides:

getUrlParams in class SearchRequestParams

Returns:

req

getLat

public Float getLat()

setLat

public void setLat(Float lat)

getLon

public Float getLon()

setLon

public void setLon(Float lon)

getRadius

public Float getRadius()

setRadius

public void setRadius(Float radius)

getWkt

public String getWkt()

setWkt

public void setWkt(String wkt)

getGk

public Boolean getGk()

Returns:

the gk

setGk

public void setGk(Boolean gk)

Parameters:

gk - the gk to set

getFq

public String[] getFq()

Get the value of fq. Adds the gk FQ if necessary...

Overrides:

getFq in class SearchRequestParams

Returns:

the value of fq

hashCode

public int hashCode()

Overrides:

hashCode in class SearchRequestParams