Package it.unimib.unimibmodules.controller

Class SurveyController

java.lang.Object

it.unimib.unimibmodules.controller.DTOMapping<Survey,SurveyDTO>

it.unimib.unimibmodules.controller.SurveyController

@RestController
@RequestMapping("/api")
public class SurveyController
extends DTOMapping<Survey,SurveyDTO>

Controller handling HTTP requests related to Survey.

Version:

0.4.1

Author:

Luca Milazzo

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	logger	Logger instance for debug purpose
private static final String	RETRIVEDALLSURVEYS	Common strings used by the logger
private static final String	RETRIVEDNSURVEYS
private final SurveyRepository	surveyRepository	Instance of SurveyRepository.
private final UserRepositoryReadOnly	userRepository	Instance of UserRepository.

Fields inherited from class it.unimib.unimibmodules.controller.DTOMapping

modelMapper

Constructor Summary

Constructors

Constructor	Description
SurveyController(UserRepositoryReadOnly userRepository, SurveyRepository surveyRepository, org.modelmapper.ModelMapper modelMapper)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	addSurvey(SurveyDTO surveyDTO)	Creates a survey, with the given name and request's date-time, that is associated to the given user id
SurveyDTO	convertToDTO(Survey survey)	Conversion of an instance of Survey to an instance of SurveyDTO
SurveyDTO	convertToDTOAndSkipQuestions(Survey survey)	Conversion of an instance of Survey to an instance of SurveyDTO skipping QuestionsList
Survey	convertToEntity(SurveyDTO surveyDTO)	Conversion of an instance of SurveyDTO to an instance of Survey
org.springframework.http.ResponseEntity<String>	deleteSurvey(int id)	Deletes the survey associated with the given id.
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findAllSurveys()	Finds all surveys.
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findAllSurveysNoQuestion()	Finds all surveys without their questions list.
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findAllSurveysNoQuestionLazy(int offset, int limit)	Finds all surveys without their questions.
org.springframework.http.ResponseEntity<SurveyDTO>	findSurvey(int id)	Finds the survey associated with the given id.
org.springframework.http.ResponseEntity<SurveyDTO>	findSurveyByCompilationCode(String code)	Finds the survey associated with the given id.
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findSurveyByText(String text)	Finds the surveys where text is contained in their names or in their identifiers.
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findSurveyByTextNoQuestions(String text)	Finds the surveys where text is contained in their names or in their identifiers without their questions list
org.springframework.http.ResponseEntity<List<SurveyDTO>>	findSurveyByTextNoQuestionsLazy(String text, int offset, int limit)	Finds the surveys where text is contained in their names or in their identifiers without their questions list using Lazy Loading parameters.
org.springframework.http.ResponseEntity<SurveyDTO>	findSurveyNoQuestion(int id)	Finds the survey associated with the given id without its questions list.
org.springframework.http.ResponseEntity<String>	modifySurvey(SurveyDTO surveyDTO)	Modifies the survey's name associated with the given surveyDTO.

Methods inherited from class java.lang.Object

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

Field Details

surveyRepository

private final SurveyRepository surveyRepository

Instance of SurveyRepository. It's used to access the Repository layer.

userRepository

private final UserRepositoryReadOnly userRepository

Instance of UserRepository. It's used to access the Repository layer.

logger

private static final org.apache.logging.log4j.Logger logger

Logger instance for debug purpose

RETRIVEDALLSURVEYS

private static final String RETRIVEDALLSURVEYS

Common strings used by the logger

See Also:

• Constant Field Values

RETRIVEDNSURVEYS

private static final String RETRIVEDNSURVEYS

See Also:

• Constant Field Values

Constructor Details

SurveyController

@Autowired
public SurveyController(UserRepositoryReadOnly userRepository,
 SurveyRepository surveyRepository,
 org.modelmapper.ModelMapper modelMapper)

Method Details

findSurveyByCompilationCode

@GetMapping("/findSurveyByCompilationCode")
public org.springframework.http.ResponseEntity<SurveyDTO> findSurveyByCompilationCode(@RequestParam(name="code")
 String code)
                                                                               throws NotFoundException

Finds the survey associated with the given id.

Parameters:

id - the id of the Survey

Returns:

If the survey has been found: an HTTP response with status 200 and the SurveyDTO

Throws:

NotFoundException - if the survey doesn't exists

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findSurvey

@GetMapping("/findSurvey")
public org.springframework.http.ResponseEntity<SurveyDTO> findSurvey(@RequestParam(name="id")
 int id)
                                                              throws NotFoundException

Finds the survey associated with the given id.

Parameters:

id - the id of the Survey

Returns:

If the survey has been found: an HTTP response with status 200 and the SurveyDTO

Throws:

NotFoundException - if the survey doesn't exists

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findSurveyNoQuestion

@GetMapping(path="/findSurveyNoQuestion/{id}")
public org.springframework.http.ResponseEntity<SurveyDTO> findSurveyNoQuestion(@PathVariable
 int id)
                                                                        throws NotFoundException

Finds the survey associated with the given id without its questions list.

Parameters:

id - the id of the Survey

Returns:

If the survey has been found: an HTTP response with status 200 and the SurveyDTO

Throws:

NotFoundException - if the survey doesn't exists

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findSurveyByText

@GetMapping("/findSurveyByText")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findSurveyByText(@RequestParam(name="text")
 String text)
                                                                          throws NotFoundException

Finds the surveys where text is contained in their names or in their identifiers.

Parameters:

text - the text to be found

Returns:

If one survey at least has been found: an HTTP response with status 200 and the SurveyDTOs

Throws:

NotFoundException - if no survey has been found

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findSurveyByTextNoQuestions

@GetMapping("/findSurveyByTextNoQuestion")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findSurveyByTextNoQuestions(@RequestParam(name="text")
 String text)
                                                                                     throws NotFoundException

Finds the surveys where text is contained in their names or in their identifiers without their questions list

Parameters:

text - the text to be found

Returns:

If one survey at least has been found: an HTTP response with status 200 and the SurveyDTOs

Throws:

NotFoundException - if no survey has been found

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findSurveyByTextNoQuestionsLazy

@GetMapping("/findSurveyByTextNoQuestionLazy")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findSurveyByTextNoQuestionsLazy(@RequestParam(name="text")
 String text,
 @RequestParam
 int offset,
 @RequestParam
 int limit)
                                                                                         throws NotFoundException

Finds the surveys where text is contained in their names or in their identifiers without their questions list using Lazy Loading parameters.

Parameters:

text - the text to be found

offset - offset for lazy loading

limit - to limit the result length

Returns:

If one survey at least has been found: an HTTP response with status 200 and the SurveyDTOs

Throws:

NotFoundException - if no survey has been found

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findAllSurveys

@GetMapping("/findAllSurveys")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findAllSurveys()
                                                                        throws NotFoundException

Finds all surveys.

Returns:

If one survey at least has been found: an HTTP response with status 200

Throws:

NotFoundException - if no surveys exist

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findAllSurveysNoQuestion

@GetMapping("/findAllSurveysNoQuestion")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findAllSurveysNoQuestion()
                                                                                  throws NotFoundException

Finds all surveys without their questions list.

Returns:

If one survey at least has been found: an HTTP response with status 200

Throws:

NotFoundException - if no surveys exist

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

findAllSurveysNoQuestionLazy

@GetMapping("/findAllSurveysNoQuestionLazy")
public org.springframework.http.ResponseEntity<List<SurveyDTO>> findAllSurveysNoQuestionLazy(@RequestParam
 int offset,
 @RequestParam
 int limit)
                                                                                      throws NotFoundException

Finds all surveys without their questions.

Returns:

If one survey at least has been found: an HTTP response with status 200

Throws:

NotFoundException - if no surveys exist

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

addSurvey

@PostMapping(path="/addSurvey",
             produces="application/json")
public org.springframework.http.ResponseEntity<String> addSurvey(@RequestBody
 SurveyDTO surveyDTO)
                                                          throws FormatException,
NotFoundException,
EmptyFieldException

Creates a survey, with the given name and request's date-time, that is associated to the given user id

Parameters:

surveyDTO - the serialized version of a Survey object

Returns:

If the survey has been created : an HTTP response with status 201

Throws:

FormatException

NotFoundException

EmptyFieldException

See Also:

• FormatException
• NotFoundException
• EmptyFieldException
• ExceptionController.handleFormatException(it.unimib.unimibmodules.exception.FormatException)

modifySurvey

@PatchMapping(path="/modifySurvey",
              produces="application/json")
public org.springframework.http.ResponseEntity<String> modifySurvey(@RequestBody
 SurveyDTO surveyDTO)
                                                             throws FormatException,
NotFoundException,
EmptyFieldException

Modifies the survey's name associated with the given surveyDTO.

Parameters:

surveyDTO - the serialized version of a Survey object

Returns:

If the survey has been updated: an HTTP response with status 200

Throws:

FormatException

NotFoundException

EmptyFieldException

See Also:

• FormatException
• NotFoundException
• EmptyFieldException
• ExceptionController.handleFormatException(it.unimib.unimibmodules.exception.FormatException)

deleteSurvey

@DeleteMapping(path="/deleteSurvey/{id}")
public org.springframework.http.ResponseEntity<String> deleteSurvey(@PathVariable
 int id)
                                                             throws FormatException

Deletes the survey associated with the given id.

Parameters:

id - the id of the survey to delete

Returns:

if the survey has been deleted : an HTTP Response with status 200

Throws:

NotFoundException

FormatException

See Also:

• NotFoundException
• ExceptionController.handleNotFoundException(it.unimib.unimibmodules.exception.NotFoundException)

convertToDTO

public SurveyDTO convertToDTO(Survey survey)

Conversion of an instance of Survey to an instance of SurveyDTO

Specified by:

convertToDTO in class DTOMapping<Survey,SurveyDTO>

Parameters:

survey - an instance of Survey

Returns:

an instance of SurveyDTO, containing the serialized data of survey

See Also:

• DTOMapping.convertToDTO(M)

convertToDTOAndSkipQuestions

public SurveyDTO convertToDTOAndSkipQuestions(Survey survey)

Conversion of an instance of Survey to an instance of SurveyDTO skipping QuestionsList

Parameters:

survey - an instance of Survey

Returns:

an instance of SurveyDTO, containing the serialized data of survey

See Also:

• DTOMapping.convertToDTO(M)

convertToEntity

public Survey convertToEntity(SurveyDTO surveyDTO)
                       throws FormatException,
NotFoundException,
EmptyFieldException

Conversion of an instance of SurveyDTO to an instance of Survey

Specified by:

convertToEntity in class DTOMapping<Survey,SurveyDTO>

Parameters:

surveyDTO - an instance of SurveyDTO

Returns:

an instance of Survey

Throws:

FormatException

EmptyFieldException

NotFoundException - when one of the queries fails

See Also:

• DTOMapping.convertToEntity(T)
• FormatException
• ExceptionController.handleFormatException(it.unimib.unimibmodules.exception.FormatException)