org.openforis.collect.web.controller

Class RecordController

java.lang.Object

org.openforis.collect.web.controller.BasicController

org.openforis.collect.web.controller.RecordController

All Implemented Interfaces:

Serializable

@Controller
 @Scope(value="session")
 @RequestMapping(value="api")
public class RecordController
extends BasicController
implements Serializable

Author:

S. Ricci

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordController.BackupDataExportParameters
static class	RecordController.CSVExportParametersForm
static class	RecordController.RecordDeleteParameters
static class	RecordController.RecordSummarySearchParameters
static class	RecordController.SearchParameters

Constructor Summary

Constructors

Constructor and Description
RecordController()

Method Summary

Modifier and Type	Method and Description
RecordProxy	createRandomRecord(int surveyId, RecordGenerator.NewRecordParameters params)
org.openforis.commons.web.Response	deleteRecord(int surveyId, @Valid RecordController.RecordDeleteParameters params)
org.openforis.commons.web.Response	demoteRecord(int surveyId, int recordId)
void	downloadBackupExportResult(javax.servlet.http.HttpServletResponse response)
void	downloadCsvExportResult(javax.servlet.http.HttpServletResponse response)
DataImportSummaryProxy	downloadRecordImportSummary(int surveyId)
void	downloadValidationReportResult(javax.servlet.http.HttpServletResponse response)
void	exportRecord(int surveyId, int recordId, int stepNumber, CSVDataExportParametersBase.OutputFormat outputFormat, javax.servlet.http.HttpServletResponse response)
void	exportRecordToCollectFormat(int surveyId, int recordId, javax.servlet.http.HttpServletResponse response)
void	exportRecordToCsv(int surveyId, int recordId, int stepNumber, javax.servlet.http.HttpServletResponse response)
void	exportRecordToExcel(int surveyId, int recordId, int stepNumber, javax.servlet.http.HttpServletResponse response)
RecordStatsGenerator.RecordsStats	generateStats(int surveyId)
int	getCount(int surveyId, Integer rootEntityDefinitionId, Integer stepNumber)
CollectJobController.JobView	getCsvDataExportJob(javax.servlet.http.HttpServletResponse response)
DataImportStatusProxy	getCsvDataImportStatus(int surveyId)
CollectJobController.JobView	getFullBackupJobView()
Map<String,Object>	loadData(int surveyId, int recordId, Integer stepNumber)
RecordProxy	loadRecord(int surveyId, int recordId, Integer stepNumber, boolean lock)
Map<String,Object>	loadRecordSummaries(int surveyId, @Valid RecordController.RecordSummarySearchParameters params)
int	loadSurveyId(int recordId)
JobProxy	moveRecords(int surveyId, String fromStep, boolean promote)
RecordProxy	newRecord(int surveyId, RecordGenerator.NewRecordParameters params)
org.openforis.commons.web.Response	promoteRecord(int surveyId, int recordId)
org.openforis.commons.web.Response	releaseRecordLock(int recordId)
CollectJobController.JobView	startBackupDataExportJob(int surveyId, RecordController.BackupDataExportParameters parameters)
CollectJobController.JobView	startCsvDataExportJob(int surveyId, RecordController.CSVExportParametersForm parameters)
CollectJobController.JobView	startCsvDataImportJob(int surveyId, org.springframework.web.multipart.MultipartFile multipartFile, String rootEntityName, String importType, String steps, Integer entityDefinitionId, boolean validateRecords, boolean deleteEntitiesBeforeImport, String newRecordVersionName)
CollectJobController.JobView	startRecordImport(int surveyId, List<Integer> entryIdsToImport, boolean validateRecords)
CollectJobController.JobView	startRecordImportSummaryJob(int surveyId, org.springframework.web.multipart.MultipartFile multipartFile, String rootEntityName)
JobProxy	startValidationResportJob(int surveyId)
org.openforis.commons.web.Response	updateOwner(int surveyId, int recordId, Map<String,String> body)

Methods inherited from class org.openforis.collect.web.controller.BasicController

generateFormValidationResponse, getSessionState

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordController

public RecordController()

Method Detail

loadData

@RequestMapping(value="survey/{surveyId}/data/records/{recordId}/binary_data.json",
                method=GET)
 @ResponseBody
public Map<String,Object> loadData(@PathVariable(value="surveyId")
                                                                                                                                                                  int surveyId,
                                                                                                                                                                  @PathVariable(value="recordId")
                                                                                                                                                                  int recordId,
                                                                                                                                                                  @RequestParam(value="step")
                                                                                                                                                                  Integer stepNumber)
                                                                                                                                                           throws Exception

Throws:

Exception

getCount

@RequestMapping(value="survey/{surveyId}/data/records/count.json",
                method=GET)
 @ResponseBody
public int getCount(@PathVariable(value="surveyId")
                                                                                                                                  int surveyId,
                                                                                                                                  @RequestParam(value="rootEntityDefinitionId",required=false)
                                                                                                                                  Integer rootEntityDefinitionId,
                                                                                                                                  @RequestParam(value="step",required=false)
                                                                                                                                  Integer stepNumber)
                                                                                                                           throws Exception

Throws:

Exception

loadRecordSummaries

@RequestMapping(value="survey/{surveyId}/data/records/summary",
                method=GET)
 @ResponseBody
public Map<String,Object> loadRecordSummaries(@PathVariable(value="surveyId")
                                                                                                                                                         int surveyId,
                                                                                                                                                         @Valid
                                                                                                                                                         @Valid RecordController.RecordSummarySearchParameters params)

loadRecord

@RequestMapping(value="survey/{surveyId}/data/records/{recordId}",
                method=GET,
                produces="application/json")
 @ResponseBody
public RecordProxy loadRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                         int surveyId,
                                                                                                                                                                                         @PathVariable(value="recordId")
                                                                                                                                                                                         int recordId,
                                                                                                                                                                                         @RequestParam(value="step",required=false)
                                                                                                                                                                                         Integer stepNumber,
                                                                                                                                                                                         @RequestParam(value="lock",required=false,defaultValue="false")
                                                                                                                                                                                         boolean lock)
                                                                                                                                                                                  throws RecordPersistenceException

Throws:

RecordPersistenceException

updateOwner

@RequestMapping(value="survey/{surveyId}/data/update/records/{recordId}",
                method=POST,
                produces="application/json")
 @ResponseBody
public org.openforis.commons.web.Response updateOwner(@PathVariable(value="surveyId")
                                                                                                                                                                                                                         int surveyId,
                                                                                                                                                                                                                         @PathVariable(value="recordId")
                                                                                                                                                                                                                         int recordId,
                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                         Map<String,String> body)
                                                                                                                                                                                                                  throws RecordLockedException,
                                                                                                                                                                                                                         MultipleEditException

Throws:

RecordLockedException

MultipleEditException

promoteRecord

@RequestMapping(value="survey/{surveyId}/data/records/promote/{recordId}",
                method=POST,
                produces="application/json")
 @ResponseBody
public org.openforis.commons.web.Response promoteRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                                                            int surveyId,
                                                                                                                                                                                                                            @PathVariable(value="recordId")
                                                                                                                                                                                                                            int recordId)
                                                                                                                                                                                                                     throws MissingRecordKeyException,
                                                                                                                                                                                                                            RecordPromoteException

Throws:

MissingRecordKeyException

RecordPromoteException

demoteRecord

@RequestMapping(value="survey/{surveyId}/data/records/demote/{recordId}",
                method=POST,
                produces="application/json")
 @ResponseBody
public org.openforis.commons.web.Response demoteRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                                                          int surveyId,
                                                                                                                                                                                                                          @PathVariable(value="recordId")
                                                                                                                                                                                                                          int recordId)
                                                                                                                                                                                                                   throws RecordPersistenceException

Throws:

RecordPersistenceException

moveRecords

@RequestMapping(value="survey/{surveyId}/data/move/records",
                method=POST,
                produces="application/json")
 @ResponseBody
public JobProxy moveRecords(@PathVariable(value="surveyId")
                                                                                                                                                                                  int surveyId,
                                                                                                                                                                                  @RequestParam
                                                                                                                                                                                  String fromStep,
                                                                                                                                                                                  @RequestParam
                                                                                                                                                                                  boolean promote)

newRecord

@Transactional
 @RequestMapping(value="survey/{surveyId}/data/records",
                method=POST,
                consumes="application/json")
 @ResponseBody
public RecordProxy newRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                              int surveyId,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              RecordGenerator.NewRecordParameters params)
                                                                                                                                                                                       throws RecordPersistenceException

Throws:

RecordPersistenceException

createRandomRecord

@Transactional
 @RequestMapping(value="survey/{surveyId}/data/records/random",
                method=POST,
                consumes="application/json")
 @ResponseBody
public RecordProxy createRandomRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                                              int surveyId,
                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                              RecordGenerator.NewRecordParameters params)
                                                                                                                                                                                                       throws RecordPersistenceException

Throws:

RecordPersistenceException

deleteRecord

@RequestMapping(value="survey/{surveyId}/data/records",
                method=DELETE,
                produces="application/json")
 @ResponseBody
public org.openforis.commons.web.Response deleteRecord(@PathVariable(value="surveyId")
                                                                                                                                                                                                          int surveyId,
                                                                                                                                                                                                          @Valid
                                                                                                                                                                                                          @Valid RecordController.RecordDeleteParameters params)
                                                                                                                                                                                                   throws RecordPersistenceException

Throws:

RecordPersistenceException

startRecordImportSummaryJob

@RequestMapping(value="survey/{surveyId}/data/import/records/summary",
                method=POST,
                consumes="multipart/form-data")
 @ResponseBody
public CollectJobController.JobView startRecordImportSummaryJob(@PathVariable(value="surveyId")
                                                                                                                                                                                                                                   int surveyId,
                                                                                                                                                                                                                                   @RequestParam(value="file")
                                                                                                                                                                                                                                   org.springframework.web.multipart.MultipartFile multipartFile,
                                                                                                                                                                                                                                   @RequestParam
                                                                                                                                                                                                                                   String rootEntityName)
                                                                                                                                                                                                                            throws IOException

Throws:

IOException

downloadRecordImportSummary

@RequestMapping(value="survey/{surveyId}/data/import/records/summary",
                method=GET)
 @ResponseBody
public DataImportSummaryProxy downloadRecordImportSummary(@PathVariable(value="surveyId")
                                                                                                                                                                            int surveyId)
                                                                                                                                                                     throws IOException

Throws:

IOException

startRecordImport

@RequestMapping(value="survey/{surveyId}/data/import/records",
                method=POST)
 @ResponseBody
public CollectJobController.JobView startRecordImport(@PathVariable(value="surveyId")
                                                                                                                                                                 int surveyId,
                                                                                                                                                                 @RequestParam
                                                                                                                                                                 List<Integer> entryIdsToImport,
                                                                                                                                                                 @RequestParam(defaultValue="true")
                                                                                                                                                                 boolean validateRecords)
                                                                                                                                                          throws IOException

Throws:

IOException

startCsvDataImportJob

@RequestMapping(value="survey/{surveyId}/data/csvimport/records",
                method=POST,
                consumes="multipart/form-data")
 @ResponseBody
public CollectJobController.JobView startCsvDataImportJob(@PathVariable(value="surveyId")
                                                                                                                                                                                                                        int surveyId,
                                                                                                                                                                                                                        @RequestParam(value="file")
                                                                                                                                                                                                                        org.springframework.web.multipart.MultipartFile multipartFile,
                                                                                                                                                                                                                        @RequestParam
                                                                                                                                                                                                                        String rootEntityName,
                                                                                                                                                                                                                        @RequestParam
                                                                                                                                                                                                                        String importType,
                                                                                                                                                                                                                        @RequestParam
                                                                                                                                                                                                                        String steps,
                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                        Integer entityDefinitionId,
                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                        boolean validateRecords,
                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                        boolean deleteEntitiesBeforeImport,
                                                                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                                                                        String newRecordVersionName)
                                                                                                                                                                                                                 throws IOException

Throws:

IOException

getCsvDataImportStatus

@RequestMapping(value="survey/{surveyId}/data/csvimport/records",
                method=GET)
 @ResponseBody
public DataImportStatusProxy getCsvDataImportStatus(@PathVariable(value="surveyId")
                                                                                                                                                                 int surveyId)

exportRecordToCsv

@RequestMapping(value="survey/{survey_id}/data/records/{record_id}/steps/{step}/content/csv/data.zip",
                method=GET,
                produces="application/zip")
public void exportRecordToCsv(@PathVariable(value="survey_id")
                                                                                                                                                                                                             int surveyId,
                                                                                                                                                                                                             @PathVariable(value="record_id")
                                                                                                                                                                                                             int recordId,
                                                                                                                                                                                                             @PathVariable(value="step")
                                                                                                                                                                                                             int stepNumber,
                                                                                                                                                                                                             javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                      throws RecordPersistenceException,
                                                                                                                                                                                                             IOException

Throws:

RecordPersistenceException

IOException

exportRecordToExcel

@RequestMapping(value="survey/{survey_id}/data/records/{record_id}/steps/{step}/content/xlsx/data.zip",
                method=GET,
                produces="application/zip")
public void exportRecordToExcel(@PathVariable(value="survey_id")
                                                                                                                                                                                                                int surveyId,
                                                                                                                                                                                                                @PathVariable(value="record_id")
                                                                                                                                                                                                                int recordId,
                                                                                                                                                                                                                @PathVariable(value="step")
                                                                                                                                                                                                                int stepNumber,
                                                                                                                                                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                         throws RecordPersistenceException,
                                                                                                                                                                                                                IOException

Throws:

RecordPersistenceException

IOException

exportRecord

public void exportRecord(int surveyId,
                         int recordId,
                         int stepNumber,
                         CSVDataExportParametersBase.OutputFormat outputFormat,
                         javax.servlet.http.HttpServletResponse response)
                  throws RecordPersistenceException,
                         IOException

Throws:

RecordPersistenceException

IOException

loadSurveyId

@RequestMapping(value="data/records/{recordId}/surveyId",
                method=GET)
 @ResponseBody
public int loadSurveyId(@PathVariable(value="recordId")
                                                                                                                             int recordId)

startCsvDataExportJob

@RequestMapping(value="survey/{surveyId}/data/records/startcsvexport",
                method=POST)
 @ResponseBody
public CollectJobController.JobView startCsvDataExportJob(@PathVariable(value="surveyId")
                                                                                                                                                                             int surveyId,
                                                                                                                                                                             @RequestBody
                                                                                                                                                                             RecordController.CSVExportParametersForm parameters)
                                                                                                                                                                      throws IOException

Throws:

IOException

getCsvDataExportJob

@RequestMapping(value="survey/{surveyId}/data/records/currentcsvexport",
                method=GET)
 @ResponseBody
public CollectJobController.JobView getCsvDataExportJob(javax.servlet.http.HttpServletResponse response)

downloadCsvExportResult

@RequestMapping(value="survey/{surveyId}/data/records/csvexportresult.zip",
                method=GET)
public void downloadCsvExportResult(javax.servlet.http.HttpServletResponse response)
                                                                                                                                     throws FileNotFoundException,
                                                                                                                                            IOException

Throws:

FileNotFoundException

IOException

startBackupDataExportJob

@RequestMapping(value="survey/{surveyId}/data/records/startbackupexport",
                method=POST)
 @ResponseBody
public CollectJobController.JobView startBackupDataExportJob(@PathVariable(value="surveyId")
                                                                                                                                                                                   int surveyId,
                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                   RecordController.BackupDataExportParameters parameters)
                                                                                                                                                                            throws IOException

Throws:

IOException

downloadBackupExportResult

@RequestMapping(value="survey/{surveyId}/data/records/exportresult.collect-data",
                method=GET)
public void downloadBackupExportResult(javax.servlet.http.HttpServletResponse response)
                                                                                                                                              throws FileNotFoundException,
                                                                                                                                                     IOException

Throws:

FileNotFoundException

IOException

exportRecordToCollectFormat

@RequestMapping(value="survey/{survey_id}/data/records/{record_id}/content/collect/data.collect-data",
                method=GET,
                produces="application/zip")
public void exportRecordToCollectFormat(@PathVariable(value="survey_id")
                                                                                                                                                                                                                       int surveyId,
                                                                                                                                                                                                                       @PathVariable(value="record_id")
                                                                                                                                                                                                                       int recordId,
                                                                                                                                                                                                                       javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                                throws RecordPersistenceException,
                                                                                                                                                                                                                       IOException

Throws:

RecordPersistenceException

IOException

generateStats

@RequestMapping(value="survey/{surveyId}/data/records/stats",
                method=GET)
 @ResponseBody
public RecordStatsGenerator.RecordsStats generateStats(@PathVariable(value="surveyId")
                                                                                                                                                                int surveyId)

startValidationResportJob

@RequestMapping(value="survey/{surveyId}/data/records/validationreport",
                method=POST)
 @ResponseBody
public JobProxy startValidationResportJob(@PathVariable(value="surveyId")
                                                                                                                                                               int surveyId)

downloadValidationReportResult

@RequestMapping(value="survey/{surveyId}/data/records/validationreport.csv",
                method=GET)
public void downloadValidationReportResult(javax.servlet.http.HttpServletResponse response)
                                                                                                                                             throws FileNotFoundException,
                                                                                                                                                    IOException

Throws:

FileNotFoundException

IOException

getFullBackupJobView

@RequestMapping(value="survey/{surveyId}/data/records/backupexportjob",
                method=GET)
 @ResponseBody
public CollectJobController.JobView getFullBackupJobView()

releaseRecordLock

@RequestMapping(value="survey/{surveyId}/data/records/releaselock/{recordId}",
                method=POST)
 @ResponseBody
public org.openforis.commons.web.Response releaseRecordLock(@PathVariable
                                                                                                                                                                                       int recordId)