au.org.ala.biocache.web

Class BreakdownController

java.lang.Object

au.org.ala.biocache.web.BreakdownController

@Controller
public class BreakdownController
extends Object

A simple controller for providing breakdowns on top of the biocache.

Author:

Dave Martin (David.Martin@csiro.au), Natasha Carter (Natasha.Carter@csiro.au)

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchDAO	searchDAO
protected SearchUtils	searchUtils

Constructor Summary

Constructors

Constructor and Description
BreakdownController()

Method Summary

Methods

Modifier and Type	Method and Description
TaxaRankCountDTO	breakdownByCollection(BreakdownRequestParams requestParams, String uid, javax.servlet.http.HttpServletResponse response) Performs a breakdown based on a collection
TaxaRankCountDTO	breakdownByDataHub(BreakdownRequestParams requestParams, String uid, javax.servlet.http.HttpServletResponse response) Performs a breakdown based on a data hub
TaxaRankCountDTO	breakdownByDataProvider(BreakdownRequestParams requestParams, String uid, javax.servlet.http.HttpServletResponse response) Performs a breakdown based on a data provider
TaxaRankCountDTO	breakdownByDataResource(BreakdownRequestParams requestParams, String uid, javax.servlet.http.HttpServletResponse response) Performs a breakdown based on a data resource
TaxaRankCountDTO	breakdownByInstitution(BreakdownRequestParams requestParams, String uid, javax.servlet.http.HttpServletResponse response) Performs a breakdown based on an institution
TaxaRankCountDTO	breakdownByQuery(BreakdownRequestParams breakdownParams, javax.servlet.http.HttpServletResponse response)
TaxaRankCountDTO	limitBreakdown(BreakdownRequestParams requestParams, javax.servlet.http.HttpServletResponse response) Performs a breakdown without limiting the collection or institution
void	setSearchDAO(SearchDAO searchDAO)

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

searchUtils

protected SearchUtils searchUtils

Constructor Detail

BreakdownController

public BreakdownController()

Method Detail

breakdownByCollection

@RequestMapping(value="/breakdown/collections/{uid}*")
@ResponseBody
public TaxaRankCountDTO breakdownByCollection(BreakdownRequestParams requestParams,
                                                                 @PathVariable(value="uid")
                                                                 String uid,
                                                                 javax.servlet.http.HttpServletResponse response)
                                       throws Exception

Performs a breakdown based on a collection

Parameters:

requestParams -

uid -

Returns:

Throws:

Exception

breakdownByInstitution

@RequestMapping(value="/breakdown/institutions/{uid}*")
@ResponseBody
public TaxaRankCountDTO breakdownByInstitution(BreakdownRequestParams requestParams,
                                                                  @PathVariable(value="uid")
                                                                  String uid,
                                                                  javax.servlet.http.HttpServletResponse response)
                                        throws Exception

Performs a breakdown based on an institution

Parameters:

requestParams -

uid -

Returns:

Throws:

Exception

breakdownByDataResource

@RequestMapping(value="/breakdown/dataResources/{uid}*")
@ResponseBody
public TaxaRankCountDTO breakdownByDataResource(BreakdownRequestParams requestParams,
                                                                   @PathVariable(value="uid")
                                                                   String uid,
                                                                   javax.servlet.http.HttpServletResponse response)
                                         throws Exception

Performs a breakdown based on a data resource

Parameters:

requestParams -

uid -

Returns:

Throws:

Exception

breakdownByDataProvider

@RequestMapping(value="/breakdown/dataProviders/{uid}*")
@ResponseBody
public TaxaRankCountDTO breakdownByDataProvider(BreakdownRequestParams requestParams,
                                                                   @PathVariable(value="uid")
                                                                   String uid,
                                                                   javax.servlet.http.HttpServletResponse response)
                                         throws Exception

Performs a breakdown based on a data provider

Parameters:

requestParams -

uid -

Returns:

Throws:

Exception

breakdownByDataHub

@RequestMapping(value="/breakdown/dataHubs/{uid}*")
@ResponseBody
public TaxaRankCountDTO breakdownByDataHub(BreakdownRequestParams requestParams,
                                                              @PathVariable(value="uid")
                                                              String uid,
                                                              javax.servlet.http.HttpServletResponse response)
                                    throws Exception

Performs a breakdown based on a data hub

Parameters:

requestParams -

uid -

Returns:

Throws:

Exception

breakdownByQuery

@RequestMapping(value="/breakdown*")
@ResponseBody
public TaxaRankCountDTO breakdownByQuery(BreakdownRequestParams breakdownParams,
                                                            javax.servlet.http.HttpServletResponse response)
                                  throws Exception

Throws:

Exception

limitBreakdown

@RequestMapping(value={"/breakdown/institutions*","/breakdown/collections*","/breakdown/data-resources*","/breakdowns/data-providers*","/breakdowns/data-hubs*"},
                method=GET)
@ResponseBody
public TaxaRankCountDTO limitBreakdown(BreakdownRequestParams requestParams,
                                                          javax.servlet.http.HttpServletResponse response)
                                throws Exception

Performs a breakdown without limiting the collection or institution

Returns:

Throws:

Exception

setSearchDAO

public void setSearchDAO(SearchDAO searchDAO)

Parameters:

searchDAO - the searchDAO to set