au.org.ala.biocache.web

Class ExploreController

java.lang.Object

au.org.ala.biocache.web.ExploreController

@Controller(value="exploreController")
public class ExploreController
extends Object

Controller for the "explore your area" page

Author:

"Nick dos Remedios ", "Natasha Carter "

Field Summary

Fields

Modifier and Type	Field and Description
static HashMap<Float,Integer>	radiusToZoomLevelMap Mapping of radius in km to OpenLayers zoom level
protected SearchDAO	searchDao Fulltext search DAO

Constructor Summary

Constructors

Constructor and Description
ExploreController()

Method Summary

Methods

Modifier and Type	Method and Description
void	getEndemicSpeciesCSV(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Returns the species that only have occurrences in the supplied WKT.
void	getHierarchy(javax.servlet.http.HttpServletResponse response)
protected PointType	getPointTypeForZoomLevel(Integer zoomLevel) Map a zoom level to a coordinate accuracy level
int	getSpeciesCountOnlyInWKT(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Returns the number of distinct species that are in the supplied region.
List<FieldResultDTO>	getSpeciesOnlyInWKT(SpatialSearchRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Returns the species that only have occurrences in the supplied WKT.
Integer[]	getYourAreaCount(SpatialSearchRequestParams requestParams, String group) Returns the number of records and distinct species in a particular species group
List<TaxaCountDTO>	listSpeciesForHigherTaxa(SpatialSearchRequestParams requestParams, String group, boolean common, org.springframework.ui.Model model) JSON web service that returns a list of species and record counts for a given location search and a higher taxa with rank.
String	radiusPointsGeoJson(SpatialSearchRequestParams requestParams, Integer zoomLevel, String bbox, String speciesGroup, org.springframework.ui.Model model) GeoJSON view of records as clusters of points within a specified radius of a given location This service will be used by explore your area.
void	setSearchDao(SearchDAO searchDao)
void	yourAreaDownload(DownloadRequestParams requestParams, String group, boolean common, javax.servlet.http.HttpServletResponse response) Occurrence search page uses SOLR JSON to display results
List<SpeciesGroupDTO>	yourAreaView(SpatialSearchRequestParams requestParams) Returns a list of species groups and counts that will need to be displayed.
Collection<SpeciesGroupDTO>	yourHierarchicalAreaView(SpatialSearchRequestParams requestParams, String speciesGroup) Returns a hierarchical listing of species groups.

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

radiusToZoomLevelMap

public static final HashMap<Float,Integer> radiusToZoomLevelMap

Mapping of radius in km to OpenLayers zoom level

Constructor Detail

ExploreController

public ExploreController()

Method Detail

getHierarchy

@RequestMapping(value="/explore/hierarchy",
                method=GET)
public void getHierarchy(javax.servlet.http.HttpServletResponse response)
                  throws Exception

Throws:

Exception

yourHierarchicalAreaView

@RequestMapping(value="/explore/hierarchy/groups*",
                method=GET)
@ResponseBody
public Collection<SpeciesGroupDTO> yourHierarchicalAreaView(SpatialSearchRequestParams requestParams,
                                                                               String speciesGroup)
                                                     throws Exception

Returns a hierarchical listing of species groups. TODO push down to service implementation.

Parameters:

requestParams -

Returns:

Throws:

Exception

yourAreaView

@RequestMapping(value="/explore/groups*",
                method=GET)
@ResponseBody
public List<SpeciesGroupDTO> yourAreaView(SpatialSearchRequestParams requestParams)
                                   throws Exception

Returns a list of species groups and counts that will need to be displayed. TODO: MOVE all the IP lat long lookup to the the client webapp. The purposes of biocache-service is to provide a service layer over the biocache.

Throws:

Exception

getYourAreaCount

@RequestMapping(value="/explore/counts/group/{group}*",
                method=GET)
@ResponseBody
public Integer[] getYourAreaCount(SpatialSearchRequestParams requestParams,
                                                     @PathVariable(value="group")
                                                     String group)
                           throws Exception

Returns the number of records and distinct species in a particular species group

Parameters:

requestParams -

group -

Returns:

Throws:

Exception

radiusPointsGeoJson

@RequestMapping(value="/geojson/radius-points",
                method=GET)
public String radiusPointsGeoJson(SpatialSearchRequestParams requestParams,
                                        @RequestParam(value="zoom",required=false,defaultValue="0")
                                        Integer zoomLevel,
                                        @RequestParam(value="bbox",required=false)
                                        String bbox,
                                        @RequestParam(value="group",required=false,defaultValue="ALL_SPECIES")
                                        String speciesGroup,
                                        org.springframework.ui.Model model)
                           throws Exception

GeoJSON view of records as clusters of points within a specified radius of a given location This service will be used by explore your area.

Throws:

Exception

getPointTypeForZoomLevel

protected PointType getPointTypeForZoomLevel(Integer zoomLevel)

Map a zoom level to a coordinate accuracy level

Parameters:

zoomLevel -

Returns:

yourAreaDownload

@RequestMapping(value="/explore/group/{group}/download*",
                method=GET)
public void yourAreaDownload(DownloadRequestParams requestParams,
                                   @PathVariable(value="group")
                                   String group,
                                   @RequestParam(value="common",required=false,defaultValue="false")
                                   boolean common,
                                   javax.servlet.http.HttpServletResponse response)
                      throws Exception

Occurrence search page uses SOLR JSON to display results

Throws:

Exception

listSpeciesForHigherTaxa

@RequestMapping(value="/explore/group/{group}*",
                method=GET)
@ResponseBody
public List<TaxaCountDTO> listSpeciesForHigherTaxa(SpatialSearchRequestParams requestParams,
                                                                      @PathVariable(value="group")
                                                                      String group,
                                                                      @RequestParam(value="common",required=false,defaultValue="false")
                                                                      boolean common,
                                                                      org.springframework.ui.Model model)
                                            throws Exception

JSON web service that returns a list of species and record counts for a given location search and a higher taxa with rank.

Parameters:

model -

Throws:

Exception

getSpeciesCountOnlyInWKT

@RequestMapping(value="/explore/counts/endemic*",
                method=GET)
@ResponseBody
public int getSpeciesCountOnlyInWKT(SpatialSearchRequestParams requestParams,
                                                       javax.servlet.http.HttpServletResponse response)
                             throws Exception

Returns the number of distinct species that are in the supplied region.

Parameters:

requestParams -

response -

Returns:

Throws:

Exception

getSpeciesOnlyInWKT

@RequestMapping(value="/explore/endemic/species*",
                method=GET)
@ResponseBody
public List<FieldResultDTO> getSpeciesOnlyInWKT(SpatialSearchRequestParams requestParams,
                                                                   javax.servlet.http.HttpServletResponse response)
                                         throws Exception

Returns the species that only have occurrences in the supplied WKT.

Returns:

Throws:

Exception

getEndemicSpeciesCSV

@RequestMapping(value="/explore/endemic/species.csv",
                method=GET)
public void getEndemicSpeciesCSV(SpatialSearchRequestParams requestParams,
                                       javax.servlet.http.HttpServletResponse response)
                          throws Exception

Returns the species that only have occurrences in the supplied WKT.

Throws:

Exception

setSearchDao

public void setSearchDao(SearchDAO searchDao)

Parameters:

searchDao - the searchDao to set