au.org.ala.biocache.web

Class ValidationRuleController

java.lang.Object

au.org.ala.biocache.web.AbstractSecureController

au.org.ala.biocache.web.ValidationRuleController

@Controller
public class ValidationRuleController
extends AbstractSecureController

A controller for the submission and lookup of validation rules against occurrence records.

Field Summary

Fields

Modifier and Type	Field and Description
protected AssertionUtils	assertionUtils
protected AuthService	authService
protected SearchDAO	searchDAO
protected SpeciesLookupService	speciesLookupService

Fields inherited from class au.org.ala.biocache.web.AbstractSecureController

apiCheckUrl

Constructor Summary

Constructors

Constructor and Description
ValidationRuleController()

Method Summary

Methods

Modifier and Type	Method and Description
void	addValidationRule(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Example expected payload { "status": "new", "ignored": false, "apiKey": "XXXXXXXXXX", "user": { "isAdmin": true, "email": "xxxxxxxx@gmail.com", "authority": 1000 }, "classification": "invalid", "area": "MULTIPOLYGON(((137.5 -26,137.5 -25.5,138 -25.5,138 -26,137.5 -26)),((134.5 -29.5,134.5 -29,135 -29,135 -29.5,134.5 -29.5)))", "lastModified": "2013-01-01T09:05:19", "id": 5090, "comment": "", "species": "Trichoglossus haematodus" }
String	applyValidationRule(String uuid, javax.servlet.http.HttpServletRequest request)
au.org.ala.biocache.model.ValidationRule	getValidationRule(String uuid, javax.servlet.http.HttpServletRequest request)
au.org.ala.biocache.model.ValidationRule[]	getValidationRules()
au.org.ala.biocache.model.ValidationRule[]	getValidationRules(String recordUuid) Returns a list of query assertions.
au.org.ala.biocache.model.ValidationRule[]	getValidationRules(String uuids, javax.servlet.http.HttpServletRequest request)
void	reinitialiseRules(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setAssertionUtils(AssertionUtils assertionUtils)
void	setAuthService(AuthService authService)
void	setSearchDAO(SearchDAO searchDAO)
void	setSpeciesLookupService(SpeciesLookupService speciesLookupService)

Methods inherited from class au.org.ala.biocache.web.AbstractSecureController

isValidKey, shouldPerformOperation, shouldPerformOperation

Methods inherited from class java.lang.Object

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

Field Detail

assertionUtils

@Inject
protected AssertionUtils assertionUtils

authService

@Inject
protected AuthService authService

speciesLookupService

@Inject
protected SpeciesLookupService speciesLookupService

searchDAO

@Inject
protected SearchDAO searchDAO

Constructor Detail

ValidationRuleController

public ValidationRuleController()

Method Detail

getValidationRules

@RequestMapping(value={"/validation/rules","/validation/rules/","/assertions/queries","/assertions/queries/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.model.ValidationRule[] getValidationRules()
                                                              throws Exception

Throws:

Exception

getValidationRule

@RequestMapping(value={"/validation/rule/{uuid}","/validation/rule/{uuid}/","/assertions/query/{uuid}","/assertions/query/{uuid}/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.model.ValidationRule getValidationRule(@PathVariable(value="uuid")
                                                                                     String uuid,
                                                                                     javax.servlet.http.HttpServletRequest request)
                                                           throws Exception

Throws:

Exception

getValidationRules

@RequestMapping(value={"/validation/rules/{uuids}","/validation/rules/{uuids}/","/assertions/queries/{uuids}","/assertions/queries/{uuids}/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.model.ValidationRule[] getValidationRules(@PathVariable(value="uuids")
                                                                                        String uuids,
                                                                                        javax.servlet.http.HttpServletRequest request)
                                                              throws Exception

Throws:

Exception

applyValidationRule

@RequestMapping(value={"/assertions/query/{uuid}/apply","/assertions/query/{uuid}/apply/","/validation/rule/{uuid}/apply","/validation/rule/{uuid}/apply/"},
                method=GET)
@ResponseBody
public String applyValidationRule(@PathVariable(value="uuid")
                                                     String uuid,
                                                     javax.servlet.http.HttpServletRequest request)
                           throws Exception

Throws:

Exception

reinitialiseRules

@RequestMapping(value="/validation/rules/rematch")
public void reinitialiseRules(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                       throws Exception

Throws:

Exception

addValidationRule

@RequestMapping(value={"/assertions/query/add","/validation/rule/add"},
                method=POST)
public void addValidationRule(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                       throws Exception

Example expected payload { "status": "new", "ignored": false, "apiKey": "XXXXXXXXXX", "user": { "isAdmin": true, "email": "xxxxxxxx@gmail.com", "authority": 1000 }, "classification": "invalid", "area": "MULTIPOLYGON(((137.5 -26,137.5 -25.5,138 -25.5,138 -26,137.5 -26)),((134.5 -29.5,134.5 -29,135 -29,135 -29.5,134.5 -29.5)))", "lastModified": "2013-01-01T09:05:19", "id": 5090, "comment": "", "species": "Trichoglossus haematodus" }

Parameters:

request -

response -

Throws:

Exception

getValidationRules

@RequestMapping(value={"/occurrences/{recordUuid}/validationRules","/occurrences/{recordUuid}/validationRules/","/occurrences/{recordUuid}/assertionQueries","/occurrences/{recordUuid}/assertionQueries/"},
                method=GET)
@ResponseBody
public au.org.ala.biocache.model.ValidationRule[] getValidationRules(@PathVariable(value="recordUuid")
                                                                                        String recordUuid)
                                                              throws Exception

Returns a list of query assertions.

Parameters:

recordUuid -

Returns:

Throws:

Exception

setAssertionUtils

public void setAssertionUtils(AssertionUtils assertionUtils)

setAuthService

public void setAuthService(AuthService authService)

setSpeciesLookupService

public void setSpeciesLookupService(SpeciesLookupService speciesLookupService)

setSearchDAO

public void setSearchDAO(SearchDAO searchDAO)