au.org.ala.biocache.web

Class WMSController

java.lang.Object

au.org.ala.biocache.web.WMSController

@Controller
public class WMSController
extends Object

This controller provides mapping services which include WMS services. Includes support for:

• GetCapabilities
• GetMap
• GetFeatureInfo
• GetMetadata

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseWsUrl
protected String	geoserverUrl
protected String	organizationName
protected String	orgCity
protected String	orgCountry
protected String	orgEmail
protected String	orgFax
protected String	orgPhone
protected String	orgPostcode
protected String	orgStateProvince
protected SearchDAO	searchDAO Fulltext search DAO
protected SearchUtils	searchUtils
protected TaxonDAO	taxonDAO

Constructor Summary

Constructors

Constructor and Description
WMSController()

Method Summary

Methods

Modifier and Type	Method and Description
void	boundingBox(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Get query bounding box as csv containing: min longitude, min latitude, max longitude, max latitude
void	generatePublicationMap(SpatialSearchRequestParams requestParams, String format, String extents, Double widthMm, Double pointRadiusMm, Integer pradiusPx, String pointColour, Double pointOpacity, String baselayer, String scale, Integer dpi, boolean outlinePoints, String outlineColour, String fileName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method that produces the downloadable map integrated in AVH/OZCAM/Biocache.
String	generateStylesForPoints()
void	generateWmsTile(SpatialSearchRequestParams requestParams, String cql_filter, String env, String srs, String styles, String bboxString, Integer width, Integer height, String cache, String requestString, boolean outlinePoints, String outlineColour, String layers, String[] hqs, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) WMS service for webportal.
void	getCapabilities(SpatialSearchRequestParams requestParams, String cql_filter, String env, String srs, String styles, String style, String bboxString, Integer width, Integer height, String cache, String requestString, boolean outlinePoints, String outlineColour, String layers, String query, String[] filterQueries, Double x, Double y, boolean spatiallyValidOnly, boolean marineOnly, boolean terrestrialOnly, boolean limitToFocus, boolean useSpeciesGroups, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Returns a get capabilities response by default.
String	getFeatureInfo(String cql_filter, String env, String bboxString, Integer width, Integer height, String styles, String srs, String queryLayers, Double x, Double y, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model)
void	getLegendGraphic(String env, String style, Integer width, Integer height, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getMetadata(String layer, String query, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model)
ParamsCacheObject	getParamCacheObject(Long id) Allows the details of a cached query to be viewed.
protected PointType	getPointTypeForDegreesPerPixel(double resolution) Map a zoom level to a coordinate accuracy level
double[]	jsonBoundingBox(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Get query bounding box as JSON array containing: min longitude, min latitude, max longitude, max latitude
List<LegendItem>	legend(SpatialSearchRequestParams requestParams, String colourMode, String returnType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get legend for a query and facet field (colourMode).
List<TaxaCountDTO>	listSpecies(SpatialSearchRequestParams requestParams) JSON web service that returns a list of species and record counts for a given location search
void	listSpeciesCsv(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) List of species for webportal as csv.
void	occurrenceGz(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Get occurrences by query as gzipped csv.
SearchResultDTO	occurrences(SpatialSearchRequestParams requestParams, org.springframework.ui.Model model) Get occurrences by query as JSON.
List<DataProviderCountDTO>	queryInfo(SpatialSearchRequestParams requestParams) List data providers for a query.
void	setBaseWsUrl(String baseWsUrl)
void	setOrganizationName(String organizationName)
void	setOrgCity(String orgCity)
void	setOrgCountry(String orgCountry)
void	setOrgEmail(String orgEmail)
void	setOrgFax(String orgFax)
void	setOrgPhone(String orgPhone)
void	setOrgPostcode(String orgPostcode)
void	setOrgStateProvince(String orgStateProvince)
void	setSearchDAO(SearchDAO searchDAO)
void	setSearchUtils(SearchUtils searchUtils)
void	setTaxonDAO(TaxonDAO taxonDAO)
Boolean	storeParams(Long id) Test presence of query params {id} in params store.
void	storeParams(SpatialSearchRequestParams requestParams, String bbox, String title, javax.servlet.http.HttpServletResponse response) Store query params list

Methods inherited from class java.lang.Object

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

Field Detail

searchDAO

@Inject
protected SearchDAO searchDAO

Fulltext search DAO

taxonDAO

@Inject
protected TaxonDAO taxonDAO

searchUtils

@Inject
protected SearchUtils searchUtils

baseWsUrl

protected String baseWsUrl

geoserverUrl

protected String geoserverUrl

organizationName

protected String organizationName

orgCity

protected String orgCity

orgStateProvince

protected String orgStateProvince

orgPostcode

protected String orgPostcode

orgCountry

protected String orgCountry

orgPhone

protected String orgPhone

orgFax

protected String orgFax

orgEmail

protected String orgEmail

Constructor Detail

WMSController

public WMSController()

Method Detail

storeParams

@RequestMapping(value={"/webportal/params","/mapping/params"},
                method=POST)
public void storeParams(SpatialSearchRequestParams requestParams,
                              @RequestParam(value="bbox",required=false,defaultValue="false")
                              String bbox,
                              @RequestParam(value="title",required=false)
                              String title,
                              javax.servlet.http.HttpServletResponse response)
                 throws Exception

Store query params list

Throws:

Exception

storeParams

@RequestMapping(value={"/webportal/params/{id}","/mapping/params/{id}"},
                method=GET)
@ResponseBody
public Boolean storeParams(@PathVariable(value="id")
                                              Long id)
                    throws Exception

Test presence of query params {id} in params store.

Throws:

Exception

getParamCacheObject

@RequestMapping(value={"/webportal/params/details/{id}","/mapping/params/details/{id}"},
                method=GET)
@ResponseBody
public ParamsCacheObject getParamCacheObject(@PathVariable(value="id")
                                                                Long id)
                                      throws Exception

Allows the details of a cached query to be viewed.

Parameters:

id -

Returns:

Throws:

Exception

listSpecies

@RequestMapping(value={"/webportal/species","/mapping/species"},
                method=GET)
@ResponseBody
public List<TaxaCountDTO> listSpecies(SpatialSearchRequestParams requestParams)
                               throws Exception

JSON web service that returns a list of species and record counts for a given location search

Throws:

Exception

listSpeciesCsv

@RequestMapping(value={"/webportal/species.csv","/mapping/species.csv"},
                method=GET)
public void listSpeciesCsv(SpatialSearchRequestParams requestParams,
                                 javax.servlet.http.HttpServletResponse response)
                    throws Exception

List of species for webportal as csv.

Parameters:

response -

Throws:

Exception

legend

@RequestMapping(value={"/webportal/legend","/mapping/legend"},
                method=GET)
@ResponseBody
public List<LegendItem> legend(SpatialSearchRequestParams requestParams,
                                                  @RequestParam(value="cm",required=false,defaultValue="")
                                                  String colourMode,
                                                  @RequestParam(value="type",required=false,defaultValue="application/csv")
                                                  String returnType,
                                                  javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
                        throws Exception

Get legend for a query and facet field (colourMode). if "Accept" header is application/json return json otherwise

Parameters:

requestParams -

colourMode -

response -

Throws:

Exception

queryInfo

@RequestMapping(value={"/webportal/dataProviders","/mapping/dataProviders"},
                method=GET)
@ResponseBody
public List<DataProviderCountDTO> queryInfo(SpatialSearchRequestParams requestParams)
                                     throws Exception

List data providers for a query.

Parameters:

requestParams -

Returns:

Throws:

Exception

boundingBox

@RequestMapping(value={"/webportal/bbox","/mapping/bbox"},
                method=GET)
public void boundingBox(SpatialSearchRequestParams requestParams,
                              javax.servlet.http.HttpServletResponse response)
                 throws Exception

Get query bounding box as csv containing: min longitude, min latitude, max longitude, max latitude

Parameters:

requestParams -

response -

Throws:

Exception

jsonBoundingBox

@RequestMapping(value={"/webportal/bounds","/mapping/bounds"},
                method=GET)
@ResponseBody
public double[] jsonBoundingBox(SpatialSearchRequestParams requestParams,
                                                   javax.servlet.http.HttpServletResponse response)
                         throws Exception

Get query bounding box as JSON array containing: min longitude, min latitude, max longitude, max latitude

Parameters:

requestParams -

response -

Returns:

Throws:

Exception

occurrences

@RequestMapping(value={"/webportal/occurrences*","/mapping/occurrences*"},
                method=GET)
@ResponseBody
public SearchResultDTO occurrences(SpatialSearchRequestParams requestParams,
                                                      org.springframework.ui.Model model)
                            throws Exception

Get occurrences by query as JSON.

Parameters:

requestParams -

Throws:

Exception

occurrenceGz

@RequestMapping(value={"/webportal/occurrences.gz","/mapping/occurrences.gz"},
                method=GET)
public void occurrenceGz(SpatialSearchRequestParams requestParams,
                               javax.servlet.http.HttpServletResponse response)
                  throws Exception

Get occurrences by query as gzipped csv.

Parameters:

requestParams -

response -

Throws:

Exception

getPointTypeForDegreesPerPixel

protected PointType getPointTypeForDegreesPerPixel(double resolution)

Map a zoom level to a coordinate accuracy level

Returns:

getMetadata

@RequestMapping(value="/ogc/getMetadata",
                method=GET)
public String getMetadata(@RequestParam(value="LAYER",required=false,defaultValue="")
                                String layer,
                                @RequestParam(value="q",required=false,defaultValue="")
                                String query,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                org.springframework.ui.Model model)
                   throws Exception

Throws:

Exception

getFeatureInfo

@RequestMapping(value="/ogc/getFeatureInfo",
                method=GET)
public String getFeatureInfo(@RequestParam(value="CQL_FILTER",required=false,defaultValue="")
                                   String cql_filter,
                                   @RequestParam(value="ENV",required=false,defaultValue="")
                                   String env,
                                   @RequestParam(value="BBOX",required=true,defaultValue="0,-90,180,0")
                                   String bboxString,
                                   @RequestParam(value="WIDTH",required=true,defaultValue="256")
                                   Integer width,
                                   @RequestParam(value="HEIGHT",required=true,defaultValue="256")
                                   Integer height,
                                   @RequestParam(value="STYLES",required=false,defaultValue="")
                                   String styles,
                                   @RequestParam(value="SRS",required=false,defaultValue="")
                                   String srs,
                                   @RequestParam(value="QUERY_LAYERS",required=false,defaultValue="")
                                   String queryLayers,
                                   @RequestParam(value="X",required=true,defaultValue="0")
                                   Double x,
                                   @RequestParam(value="Y",required=true,defaultValue="0")
                                   Double y,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   org.springframework.ui.Model model)
                      throws Exception

Throws:

Exception

getLegendGraphic

@RequestMapping(value="/ogc/legendGraphic",
                method=GET)
public void getLegendGraphic(@RequestParam(value="ENV",required=false,defaultValue="")
                                   String env,
                                   @RequestParam(value="STYLE",required=false,defaultValue="8b0000;opacity=1;size=5")
                                   String style,
                                   @RequestParam(value="WIDTH",required=false,defaultValue="30")
                                   Integer width,
                                   @RequestParam(value="HEIGHT",required=false,defaultValue="20")
                                   Integer height,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                      throws Exception

Throws:

Exception

getCapabilities

@RequestMapping(value={"/ogc/ows","/ogc/capabilities"},
                method=GET)
public void getCapabilities(SpatialSearchRequestParams requestParams,
                                  @RequestParam(value="CQL_FILTER",required=false,defaultValue="")
                                  String cql_filter,
                                  @RequestParam(value="ENV",required=false,defaultValue="")
                                  String env,
                                  @RequestParam(value="SRS",required=false,defaultValue="EPSG:900913")
                                  String srs,
                                  @RequestParam(value="STYLES",required=false,defaultValue="")
                                  String styles,
                                  @RequestParam(value="STYLE",required=false,defaultValue="")
                                  String style,
                                  @RequestParam(value="BBOX",required=false,defaultValue="")
                                  String bboxString,
                                  @RequestParam(value="WIDTH",required=false,defaultValue="256")
                                  Integer width,
                                  @RequestParam(value="HEIGHT",required=false,defaultValue="256")
                                  Integer height,
                                  @RequestParam(value="CACHE",required=false,defaultValue="off")
                                  String cache,
                                  @RequestParam(value="REQUEST",required=false,defaultValue="")
                                  String requestString,
                                  @RequestParam(value="OUTLINE",required=false,defaultValue="false")
                                  boolean outlinePoints,
                                  @RequestParam(value="OUTLINECOLOUR",required=false,defaultValue="0x000000")
                                  String outlineColour,
                                  @RequestParam(value="LAYERS",required=false,defaultValue="")
                                  String layers,
                                  @RequestParam(value="q",required=false,defaultValue="*:*")
                                  String query,
                                  @RequestParam(value="fq",required=false)
                                  String[] filterQueries,
                                  @RequestParam(value="X",required=true,defaultValue="0")
                                  Double x,
                                  @RequestParam(value="Y",required=true,defaultValue="0")
                                  Double y,
                                  @RequestParam(value="spatiallyValidOnly",required=false,defaultValue="true")
                                  boolean spatiallyValidOnly,
                                  @RequestParam(value="marineSpecies",required=false,defaultValue="false")
                                  boolean marineOnly,
                                  @RequestParam(value="terrestrialSpecies",required=false,defaultValue="false")
                                  boolean terrestrialOnly,
                                  @RequestParam(value="limitToFocus",required=false,defaultValue="true")
                                  boolean limitToFocus,
                                  @RequestParam(value="useSpeciesGroups",required=false,defaultValue="false")
                                  boolean useSpeciesGroups,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  org.springframework.ui.Model model)
                     throws Exception

Returns a get capabilities response by default.

Parameters:

requestParams -

cql_filter -

env -

srs -

styles -

style -

bboxString -

width -

height -

cache -

requestString -

outlinePoints -

outlineColour -

layers -

query -

filterQueries -

x -

y -

spatiallyValidOnly -

marineOnly -

terrestrialOnly -

limitToFocus -

useSpeciesGroups -

request -

response -

model -

Throws:

Exception

generateStylesForPoints

public String generateStylesForPoints()

generateWmsTile

@RequestMapping(value={"/webportal/wms/reflect","/ogc/wms/reflect","/mapping/wms/reflect"},
                method=GET)
public void generateWmsTile(SpatialSearchRequestParams requestParams,
                                  @RequestParam(value="CQL_FILTER",required=false,defaultValue="")
                                  String cql_filter,
                                  @RequestParam(value="ENV",required=false,defaultValue="")
                                  String env,
                                  @RequestParam(value="SRS",required=false,defaultValue="EPSG:900913")
                                  String srs,
                                  @RequestParam(value="STYLES",required=false,defaultValue="")
                                  String styles,
                                  @RequestParam(value="BBOX",required=true,defaultValue="")
                                  String bboxString,
                                  @RequestParam(value="WIDTH",required=true,defaultValue="256")
                                  Integer width,
                                  @RequestParam(value="HEIGHT",required=true,defaultValue="256")
                                  Integer height,
                                  @RequestParam(value="CACHE",required=true,defaultValue="off")
                                  String cache,
                                  @RequestParam(value="REQUEST",required=true,defaultValue="")
                                  String requestString,
                                  @RequestParam(value="OUTLINE",required=true,defaultValue="false")
                                  boolean outlinePoints,
                                  @RequestParam(value="OUTLINECOLOUR",required=true,defaultValue="0x000000")
                                  String outlineColour,
                                  @RequestParam(value="LAYERS",required=false,defaultValue="")
                                  String layers,
                                  @RequestParam(value="HQ",required=false)
                                  String[] hqs,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                     throws Exception

WMS service for webportal.

Parameters:

cql_filter - q value.

env - ';' delimited field:value pairs. See Env

bboxString -

width -

height -

cache - 'on' = use cache, 'off' = do not use cache this also removes any related cache data.

response -

Throws:

Exception

generatePublicationMap

@RequestMapping(value={"/webportal/wms/image","/mapping/wms/image"},
                method=GET)
public void generatePublicationMap(SpatialSearchRequestParams requestParams,
                                         @RequestParam(value="format",required=false,defaultValue="jpg")
                                         String format,
                                         @RequestParam(value="extents",required=true)
                                         String extents,
                                         @RequestParam(value="widthmm",required=false,defaultValue="60")
                                         Double widthMm,
                                         @RequestParam(value="pradiusmm",required=false,defaultValue="2")
                                         Double pointRadiusMm,
                                         @RequestParam(value="pradiuspx",required=false)
                                         Integer pradiusPx,
                                         @RequestParam(value="pcolour",required=false,defaultValue="FF0000")
                                         String pointColour,
                                         @RequestParam(value="popacity",required=false,defaultValue="0.8")
                                         Double pointOpacity,
                                         @RequestParam(value="baselayer",required=false,defaultValue="world")
                                         String baselayer,
                                         @RequestParam(value="scale",required=false,defaultValue="off")
                                         String scale,
                                         @RequestParam(value="dpi",required=false,defaultValue="300")
                                         Integer dpi,
                                         @RequestParam(value="outline",required=true,defaultValue="false")
                                         boolean outlinePoints,
                                         @RequestParam(value="outlineColour",required=true,defaultValue="#000000")
                                         String outlineColour,
                                         @RequestParam(value="fileName",required=false)
                                         String fileName,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                            throws Exception

Method that produces the downloadable map integrated in AVH/OZCAM/Biocache.

Parameters:

requestParams -

format -

extents -

widthMm -

pointRadiusMm -

pradiusPx -

pointColour -

pointOpacity -

baselayer -

scale -

dpi -

outlinePoints -

outlineColour -

fileName -

request -

response -

Throws:

Exception

setTaxonDAO

public void setTaxonDAO(TaxonDAO taxonDAO)

setSearchDAO

public void setSearchDAO(SearchDAO searchDAO)

setSearchUtils

public void setSearchUtils(SearchUtils searchUtils)

setBaseWsUrl

public void setBaseWsUrl(String baseWsUrl)

setOrganizationName

public void setOrganizationName(String organizationName)

setOrgCity

public void setOrgCity(String orgCity)

setOrgStateProvince

public void setOrgStateProvince(String orgStateProvince)

setOrgPostcode

public void setOrgPostcode(String orgPostcode)

setOrgCountry

public void setOrgCountry(String orgCountry)

setOrgPhone

public void setOrgPhone(String orgPhone)

setOrgFax

public void setOrgFax(String orgFax)

setOrgEmail

public void setOrgEmail(String orgEmail)