me.nunum.whereami.controller

Class LocalizationController

java.lang.Object

me.nunum.whereami.controller.LocalizationController

All Implemented Interfaces:

java.lang.AutoCloseable

public class LocalizationController
extends java.lang.Object
implements java.lang.AutoCloseable

Constructor Summary

Constructors

Constructor and Description
LocalizationController() Constructor

Method Summary

Modifier and Type	Method and Description
void	close()
DTO	deleteLocalizationRequest(java.security.Principal userPrincipal, java.lang.Long localizationId) Delete a specific localization, this will cascade, meaning, all associated positions and training requests will be deleted.
Localization	localization(java.security.Principal principal, java.lang.Long localizationId) Retrieve localization by their Id
java.util.List<DTO>	localizations(java.security.Principal principal, java.util.Optional<java.lang.Integer> page, java.util.Optional<java.lang.String> localizationName, java.util.Optional<java.lang.String> trained, java.util.Optional<java.lang.Boolean> onlyUserLocalizations) Paginate localizations
DTO	newLocalization(java.security.Principal principal, NewLocalizationRequest request) Create new localization
DTO	newSpamReport(java.security.Principal userPrincipal, Localization localization) Report a specific localization
DTO	processPredictionFeedback(java.security.Principal userPrincipal, java.lang.Long localizationId, java.lang.Long predictionId, UpdatePredictionRequest request)
java.util.List<DTO>	requestNewPrediction(java.security.Principal userPrincipal, java.lang.Long id, NewPredictionRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizationController

public LocalizationController()

Constructor

Method Detail

localizations

public java.util.List<DTO> localizations(java.security.Principal principal,
                                         java.util.Optional<java.lang.Integer> page,
                                         java.util.Optional<java.lang.String> localizationName,
                                         java.util.Optional<java.lang.String> trained,
                                         java.util.Optional<java.lang.Boolean> onlyUserLocalizations)

Paginate localizations

Parameters:

principal - See Principal

page - Nullable Page

localizationName - Nullable name for search

Returns:

List of LocalizationDTO

newLocalization

public DTO newLocalization(java.security.Principal principal,
                           NewLocalizationRequest request)

Create new localization

Parameters:

principal - See Principal

request - See NewLocalizationRequest

Returns:

See LocalizationDTO

Throws:

EntityAlreadyExists - Try to persist the same localization name for a given user

deleteLocalizationRequest

public DTO deleteLocalizationRequest(java.security.Principal userPrincipal,
                                     java.lang.Long localizationId)

Delete a specific localization, this will cascade, meaning, all associated positions and training requests will be deleted.

Parameters:

userPrincipal - See Principal

localizationId - Id of the localization

Returns:

See LocalizationDTO

Throws:

EntityNotFoundException - Localization does not exists

ForbiddenEntityDeletionException - Requester is not the owner of entity

newSpamReport

public DTO newSpamReport(java.security.Principal userPrincipal,
                         Localization localization)

Report a specific localization

Parameters:

userPrincipal - See Principal

localization - See Localization

Returns:

See LocalizationReportDTO

Throws:

EntityNotFoundException - Localization does not exists

localization

public Localization localization(java.security.Principal principal,
                                 java.lang.Long localizationId)

Retrieve localization by their Id

Parameters:

localizationId - Localization Id

Returns:

see Localization

Throws:

EntityNotFoundException - If localization not exists

requestNewPrediction

public java.util.List<DTO> requestNewPrediction(java.security.Principal userPrincipal,
                                                java.lang.Long id,
                                                NewPredictionRequest request)

processPredictionFeedback

public DTO processPredictionFeedback(java.security.Principal userPrincipal,
                                     java.lang.Long localizationId,
                                     java.lang.Long predictionId,
                                     UpdatePredictionRequest request)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception