au.org.ala.biocache.web

Class MapController

java.lang.Object

au.org.ala.biocache.web.MapController

All Implemented Interfaces:

org.springframework.web.context.ServletConfigAware

@Controller(value="mapController")
public class MapController
extends Object
implements org.springframework.web.context.ServletConfigAware

WMS and static map controller. This controller generates static PNG image files that provide a heatmap of occurrences. TODO: This functionality is currently only supporting overview maps for Australia but could be extended to support other regions.

Author:

"Ajay Ranipeta "

Field Summary

Fields

Modifier and Type	Field and Description
protected String	heatmapOutputDir
protected SearchDAO	searchDAO
protected SearchUtils	searchUtils Search Utils helper class

Constructor Summary

Constructors

Constructor and Description
MapController()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	bboxToQuery(String bbox, ArrayList<String> fqList) Reformat bbox param to SOLR spatial query and add to fq list
int	convertLatToPixel(double lat)
int	convertLngToPixel(double lng)
void	generateStaticHeatmapImages(SpatialSearchRequestParams requestParams, boolean generateLegend, boolean forcePointsDisplay, Integer pointHeatMapThreshold, String defaultPointColour, String[] colourByFq, String[] colours, Float opacity, javax.servlet.http.HttpServletRequest request) Generate heatmap image (and associated legend if applicable)
String	getOccurrencesInformation(SpatialSearchRequestParams requestParams, Integer zoomLevel, String callback, org.springframework.ui.Model model, javax.servlet.http.HttpServletResponse response)
protected PointType	getPointTypeForZoomLevel(Integer zoomLevel) Map a zoom level to a coordinate accuracy level
void	pointLegendImage(Integer colourby, Integer widthObj, Integer heightObj, javax.servlet.http.HttpServletResponse response)
void	pointsWmsImage(SpatialSearchRequestParams requestParams, Integer colourby, Integer widthObj, Integer heightObj, Integer zoomLevel, Integer symsize, String symbol, String bboxString, String type, boolean outlinePoints, String outlineColour, javax.servlet.http.HttpServletResponse response) Deprecated.
void	setSearchDAO(SearchDAO searchDAO)
void	setSearchUtils(SearchUtils searchUtils)
void	setServletConfig(javax.servlet.ServletConfig cfg)
void	speciesDensityLegend(SpatialSearchRequestParams requestParams, boolean forceRefresh, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method creates and renders a density map legend for a species.
void	speciesDensityMap(SpatialSearchRequestParams requestParams, boolean forceRefresh, boolean forcePointsDisplay, String pointColour, String colourByFqCSV, String coloursCSV, Integer pointHeatMapThreshold, Float opacity, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method creates and renders a density map for a species.

Methods inherited from class java.lang.Object

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

Field Detail

heatmapOutputDir

protected String heatmapOutputDir

searchDAO

@Inject
protected SearchDAO searchDAO

searchUtils

@Inject
protected SearchUtils searchUtils

Search Utils helper class

Constructor Detail

MapController

public MapController()

Method Detail

pointsWmsImage

@Deprecated
@RequestMapping(value="/occurrences/wms",
                method=GET)
public void pointsWmsImage(SpatialSearchRequestParams requestParams,
                                            @RequestParam(value="colourby",required=false,defaultValue="0")
                                            Integer colourby,
                                            @RequestParam(value="width",required=false,defaultValue="256")
                                            Integer widthObj,
                                            @RequestParam(value="height",required=false,defaultValue="256")
                                            Integer heightObj,
                                            @RequestParam(value="zoom",required=false,defaultValue="0")
                                            Integer zoomLevel,
                                            @RequestParam(value="symsize",required=false,defaultValue="4")
                                            Integer symsize,
                                            @RequestParam(value="symbol",required=false,defaultValue="circle")
                                            String symbol,
                                            @RequestParam(value="bbox",required=false,defaultValue="110,-45,157,-9")
                                            String bboxString,
                                            @RequestParam(value="type",required=false,defaultValue="normal")
                                            String type,
                                            @RequestParam(value="outline",required=true,defaultValue="false")
                                            boolean outlinePoints,
                                            @RequestParam(value="outlineColour",required=true,defaultValue="0x000000")
                                            String outlineColour,
                                            javax.servlet.http.HttpServletResponse response)
                    throws Exception

Deprecated.

Throws:

Exception

getOccurrencesInformation

@RequestMapping(value="/occurrences/info",
                method=GET)
public String getOccurrencesInformation(SpatialSearchRequestParams requestParams,
                                              @RequestParam(value="zoom",required=false,defaultValue="0")
                                              Integer zoomLevel,
                                              @RequestParam(value="callback",required=false)
                                              String callback,
                                              org.springframework.ui.Model model,
                                              javax.servlet.http.HttpServletResponse response)
                                 throws Exception

Throws:

Exception

pointLegendImage

@RequestMapping(value="/occurrences/legend",
                method=GET)
public void pointLegendImage(@RequestParam(value="colourby",required=false,defaultValue="0")
                                   Integer colourby,
                                   @RequestParam(value="width",required=false,defaultValue="50")
                                   Integer widthObj,
                                   @RequestParam(value="height",required=false,defaultValue="50")
                                   Integer heightObj,
                                   javax.servlet.http.HttpServletResponse response)

convertLatToPixel

public int convertLatToPixel(double lat)

convertLngToPixel

public int convertLngToPixel(double lng)

bboxToQuery

protected void bboxToQuery(String bbox,
               ArrayList<String> fqList)

Reformat bbox param to SOLR spatial query and add to fq list

Parameters:

bbox -

fqList -

getPointTypeForZoomLevel

protected PointType getPointTypeForZoomLevel(Integer zoomLevel)

Map a zoom level to a coordinate accuracy level

Parameters:

zoomLevel -

Returns:

speciesDensityMap

@RequestMapping(value={"/density/map","/occurrences/static"},
                method=GET)
@ResponseBody
public void speciesDensityMap(SpatialSearchRequestParams requestParams,
                                                 @RequestParam(value="forceRefresh",required=false,defaultValue="false")
                                                 boolean forceRefresh,
                                                 @RequestParam(value="forcePointsDisplay",required=false,defaultValue="false")
                                                 boolean forcePointsDisplay,
                                                 @RequestParam(value="pointColour",required=false,defaultValue="0000ff")
                                                 String pointColour,
                                                 @RequestParam(value="colourByFq",required=false,defaultValue="")
                                                 String colourByFqCSV,
                                                 @RequestParam(value="colours",required=false,defaultValue="")
                                                 String coloursCSV,
                                                 @RequestParam(value="pointHeatMapThreshold",required=false,defaultValue="500")
                                                 Integer pointHeatMapThreshold,
                                                 @RequestParam(value="opacity",required=false,defaultValue="1.0")
                                                 Float opacity,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)
                       throws Exception

This method creates and renders a density map for a species.

Throws:

Exception

speciesDensityLegend

@RequestMapping(value="/density/legend",
                method=GET)
@ResponseBody
public void speciesDensityLegend(SpatialSearchRequestParams requestParams,
                                                    @RequestParam(value="forceRefresh",required=false,defaultValue="false")
                                                    boolean forceRefresh,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                          throws Exception

This method creates and renders a density map legend for a species.

Throws:

Exception

generateStaticHeatmapImages

public void generateStaticHeatmapImages(SpatialSearchRequestParams requestParams,
                               boolean generateLegend,
                               boolean forcePointsDisplay,
                               Integer pointHeatMapThreshold,
                               String defaultPointColour,
                               String[] colourByFq,
                               String[] colours,
                               Float opacity,
                               javax.servlet.http.HttpServletRequest request)
                                 throws Exception

Generate heatmap image (and associated legend if applicable)

Parameters:

requestParams -

Throws:

Exception

setSearchDAO

public void setSearchDAO(SearchDAO searchDAO)

setSearchUtils

public void setSearchUtils(SearchUtils searchUtils)

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig cfg)

Specified by:

setServletConfig in interface org.springframework.web.context.ServletConfigAware