Package dev.karlkadak.backend.service

Class CityManager

java.lang.Object

dev.karlkadak.backend.service.CityManager

@Service
public class CityManager
extends Object

Used for managing the cities and their tracking in the database
Also logs the management actions using Logger

Field Summary

Fields

Modifier and Type	Field	Description
private String	apiKey	API key gathered from application.properties which is used for accessing the OpenWeather API
private final CityRepository	cityRepository
private final Logger	logger
private final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
private final org.springframework.web.client.RestTemplate	restTemplate
private final WeatherDataImporter	weatherDataImporter

Constructor Summary

Constructors

Constructor	Description
CityManager(CityRepository cityRepository, Logger logger, org.springframework.web.client.RestTemplate restTemplate, com.fasterxml.jackson.databind.ObjectMapper objectMapper, WeatherDataImporter weatherDataImporter)

Method Summary

Modifier and Type	Method	Description
City	disableImporting(long id)	Disables the weather data tracking for City object with given ID
City	enableImporting(String name)	Adds a City object with the given name to the database or enables tracking its weather data in case it already exists
private boolean	nameFormattedCorrectly(String name)	Used for preliminary checking of a city name's validity Refuses malformed names
(package private) City	retrieveCompleteCity(String name)	Retrieves a complete City object using the city name received using the OpenWeather API In case such city already exists in the database, returns that instance instead Needs to be package-private in order to test directly

Methods inherited from class java.lang.Object

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

Field Details

cityRepository

private final CityRepository cityRepository

logger

private final Logger logger

restTemplate

private final org.springframework.web.client.RestTemplate restTemplate

objectMapper

private final com.fasterxml.jackson.databind.ObjectMapper objectMapper

weatherDataImporter

private final WeatherDataImporter weatherDataImporter

apiKey

@Value("${openweather.api.key}")
private String apiKey

API key gathered from application.properties which is used for accessing the OpenWeather API

Constructor Details

CityManager

@Autowired
public CityManager(CityRepository cityRepository,
 Logger logger,
 org.springframework.web.client.RestTemplate restTemplate,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 WeatherDataImporter weatherDataImporter)

Method Details

enableImporting

public City enableImporting(String name)

Adds a City object with the given name to the database or enables tracking its weather data in case it already exists

Parameters:

name - name of the city to add / toggle

Returns:

generated / toggled City object

disableImporting

public City disableImporting(long id)

Disables the weather data tracking for City object with given ID

Parameters:

id - ID of the City object to disable

Returns:

toggled City object

retrieveCompleteCity

City retrieveCompleteCity(String name)

Retrieves a complete City object using the city name received using the OpenWeather API
In case such city already exists in the database, returns that instance instead
Needs to be package-private in order to test directly

Parameters:

name - city name to look up

Returns:

a City object linked to the name of the city input, if city is present in database returns that instance

nameFormattedCorrectly

private boolean nameFormattedCorrectly(String name)

Used for preliminary checking of a city name's validity
Refuses malformed names

Parameters:

name - complete name of the city to check

Returns:

true for acceptable, false for malformed city name