au.org.ala.biocache.dto

Class DownloadRequestParams

java.lang.Object

au.org.ala.biocache.dto.SearchRequestParams

au.org.ala.biocache.dto.SpatialSearchRequestParams

au.org.ala.biocache.dto.DownloadRequestParams

public class DownloadRequestParams
extends SpatialSearchRequestParams

Data Transfer Object to represent the request parameters required to download the results of a search.

Author:

"Natasha Carter "

Field Summary

Fields

Modifier and Type	Field and Description
protected String	email
protected Character	esc The CSV escape character to use
protected String	extra CSV list of extra fields to be added to the download - useful if wish to make use of default list
protected String	fields CSV list of fields that should be downloaded.
protected String	file
protected String	fileType
protected String	qa the CSV list of issue types to include in the download, defaults to all.
protected String	reason
protected Integer	reasonTypeId
protected Character	sep The CSV separator to use
protected Integer	sourceTypeId

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

gk, lat, lon, radius, 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
DownloadRequestParams()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEmail()
Character	getEsc()
String	getExtra()
String	getFields()
String	getFile()
String	getFileType()
String	getQa()
String	getReason()
Integer	getReasonTypeId()
Character	getSep()
Integer	getSourceTypeId()
void	setEmail(String email)
void	setEsc(Character esc)
void	setExtra(String extra)
void	setFields(String fields)
void	setFile(String file)
void	setFileType(String fileType)
void	setQa(String qa)
void	setReason(String reason)
void	setReasonTypeId(Integer reasonTypeId)
void	setSep(Character sep)
void	setSourceTypeId(Integer sourceTypeId)
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.SpatialSearchRequestParams

addSpatialParams, getEncodedParams, getFq, getGk, getLat, getLon, getRadius, getUrlParams, getWkt, hashCode, setGk, setLat, setLon, setRadius, setWkt

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

email

protected String email

reason

protected String reason

file

protected String file

fields

protected String fields

CSV list of fields that should be downloaded. If el or cl will need to map to appropriate column name

extra

protected String extra

CSV list of extra fields to be added to the download - useful if wish to make use of default list

qa

protected String qa

the CSV list of issue types to include in the download, defaults to all. Also supports none.

sep

protected Character sep

The CSV separator to use

esc

protected Character esc

The CSV escape character to use

reasonTypeId

@NotNull
@LogType(type="reason")
protected Integer reasonTypeId

sourceTypeId

@LogType(type="source")
protected Integer sourceTypeId

fileType

@Pattern(regexp="(csv|shp)")
protected String fileType

Constructor Detail

DownloadRequestParams

public DownloadRequestParams()

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 SpatialSearchRequestParams

Returns:

request parameters string

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getFile

public String getFile()

setFile

public void setFile(String file)

getReason

public String getReason()

setReason

public void setReason(String reason)

getFields

public String getFields()

Returns:

the fields

setFields

public void setFields(String fields)

Parameters:

fields - the fields to set

getExtra

public String getExtra()

Returns:

the extra

setExtra

public void setExtra(String extra)

Parameters:

extra - the extra to set

getReasonTypeId

public Integer getReasonTypeId()

Returns:

the reasonTypeId

setReasonTypeId

public void setReasonTypeId(Integer reasonTypeId)

Parameters:

reasonTypeId - the reasonTypeId to set

getSourceTypeId

public Integer getSourceTypeId()

Returns:

the sourceId

setSourceTypeId

public void setSourceTypeId(Integer sourceTypeId)

Parameters:

sourceTypeId - the sourceId to set

getFileType

public String getFileType()

Returns:

the fileType

setFileType

public void setFileType(String fileType)

Parameters:

fileType - the fileType to set

getQa

public String getQa()

Returns:

the qa

setQa

public void setQa(String qa)

Parameters:

qa - the qa to set

getEsc

public Character getEsc()

setEsc

public void setEsc(Character esc)

getSep

public Character getSep()

setSep

public void setSep(Character sep)